Package index • ctoclient

Connecting to a server

Authenticate against a SurveyCTO server and manage the session that every other function in the package uses.

cto_connect() cto_set_connection() cto_is_connected(): Connect to and manage a SurveyCTO Server connection

Forms and submission data

Download submissions and the form definitions that describe them.

cto_form_data(): Download and Tidy SurveyCTO Form Data
cto_form_metadata() cto_form_definition(): Download SurveyCTO Form Metadata and Definitions
cto_form_attachment(): Download Attachments from a SurveyCTO Form
cto_form_data_attachment(): Download Attachments from SurveyCTO Form Data

Documenting a form

Turn a form definition into something a human or another package can read: a Stata do-file, a Word review document, or one of the server’s own generated files.

cto_form_dofile(): Generate a Stata Do-File with Variable and Value Labels from a SurveyCTO Form
cto_form_docx(): Generate a Printable Word Document of a Deployed SurveyCTO Form
cto_docx_palette(): Row Colours Used by the Form Review Document
cto_form_languages() cto_form_stata_template() cto_form_printable() cto_form_mail_template(): Download SurveyCTO Form Files and Templates

Server datasets

Create, populate, download and remove the server-side datasets that forms pre-load and pull choices from.

cto_dataset_list(): List Available Server Datasets
cto_dataset_info(): Get Dataset Properties
cto_dataset_create() cto_dataset_upload(): Create or Upload to Server Datasets
cto_dataset_download(): Download SurveyCTO Server Datasets
cto_dataset_delete() cto_dataset_purge(): Delete or Purge a Dataset

Server metadata and administration

Inspect what a server holds and who can reach it. cto_form_ids() lives here because it shares a help page with the other listing functions.

cto_form_ids() cto_metadata() cto_group_list() cto_team_list() cto_role_list() cto_user_list(): Retrieve Server Metadata and Resource Lists