title: 'ruODK: An R Client for the ODK Central API' authors: - affiliation: 1 name: Florian Wendelin Mayer orcid: 0000-0003-4269-4242 date: "20 July 2020" output: pdf_document bibliography: paper.bib tags: - database - open-data - opendatakit - odk - api - data - dataset affiliations: - index: 1 name: Department of Biodiversity, Conservation and Attractions, Western Australia
ruODK [@ruodk] is an R Client for the ODK Central API.
Open Data Kit (ODK, [@odk], [@hartung]) is a suite of open source tools that help organizations collect and manage data.
The core ODK tools are [@odkdocs]:
The core workflow of ODK is:
At the time of writing, ODK Central is being introduced as a replacement for ODK Aggregate.
While the use of ODK Aggregate is well established, the use of ODK Central is new to most users. As ODK Central provides all of its content through a well-documented API [@odkapi], there is an opportunity to create API wrappers to assist with the data retrieval from ODK Central.
ruODK [@ruodk], currently available from GitHub [@github], is the first dedicated R Client for the ODK Central API.
A typical data flow involves a form builder (ODK Build), a data clearinghouse (ODK Central), an electronic data capture app (ODK Collect), and a way to automate data access and analysis (ruODK).
ruODK
aims:
Smaller projects, such as ephemeral research projects or proof of concept studies, may generate a manageable number of form submissions over a limited amount of time.
Here, it may be sufficient to export the entire set of submissions, analyse and visualise it, and generate some products such as a CSV export of the data, vector or raster figures and maps for publications, and a rendered report.
The vignettes "odata-api" and "restful-api" show examples of this use case. They differ in that the vignette "odata-api" retrieves submissions through the OData API, while the vignette "restful-api" retrieves submissions through the RESTful API.
Long-term projects, such as environmental monitoring programs, may generate many thousand submissions over a long, ongoing period of time.
Such projects typically store their data in dedicated databases. There, the data can be value-added through QA/QC/review, through integration with other data sources, and through further data processing. This requires the data to be regularly and incrementally exported from ODK Central, transformed into the target data formats (which may differ from ODK Central's output), and loaded into the target database.
In this case, ruODK assists with the retrieval of data, inspection of new vs. existing submissions, and export into an intermediary format, such as CSV snapshots.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.