Skip to contents

Overview

SurveyCTO is a platform for mobile data collection in offline settings. The rsurveycto R package uses the SurveyCTO REST API to read datasets and forms from a SurveyCTO server into R as data.tables and to download file attachments. The package also has limited support to write datasets to a server.

Installation

Install from CRAN:

install.packages('rsurveycto')

Install the development version:

if (!requireNamespace('remotes', quietly = TRUE))
  install.packages('remotes')
remotes::install_github('agency-fund/rsurveycto')

Usage

A basic example:

library('data.table')
library('rsurveycto')

# user must have permission to download data and
# "allow server API access" must be enabled
auth = scto_auth('PATH_TO_AUTH_FILE')

# read a single dataset or form
cases = scto_read(auth, 'cases')

# get a table of all datasets and forms
catalog = scto_catalog(auth)

For more details, see the reference documentation.