Package: ruODK 1.6.3

Florian W. Mayer

ruODK: An R Client for the ODK Central API

Access and tidy up data from the 'ODK Central' API. 'ODK Central' is a clearinghouse for digitally captured data using ODK <https://docs.getodk.org/central-intro/>. It manages user accounts and permissions, stores form definitions, and allows data collection clients like 'ODK Collect' to connect to it for form download and submission upload. The 'ODK Central' API is documented at <https://docs.getodk.org/central-api/>.

Authors:Florian W. Mayer [aut, cre], Maëlle Salmon [rev], Karissa Whiting [rev], Jason Taylor [rev], Marcelo Tyszler [ctb], Hélène Langet [ctb], DBCA [cph, fnd], NWSFTCP [fnd]

ruODK_1.6.3.tar.gz
ruODK_1.6.3.zip(r-4.7-any)ruODK_1.6.3.zip(r-4.6-any)ruODK_1.6.3.zip(r-4.5-any)
ruODK_1.6.3.tgz(r-4.6-any)ruODK_1.6.3.tgz(r-4.5-any)
ruODK_1.6.3.tar.gz(r-4.7-any)ruODK_1.6.3.tar.gz(r-4.6-any)
ruODK_1.6.3.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
ruODK/json (API)

# Install 'ruODK' in R:
install.packages('ruODK', repos = c('https://ropensci.r-universe.dev', 'https://cloud.r-project.org'))

Reviews:rOpenSci Software Review #335

Bug tracker:https://github.com/ropensci/ruodk/issues

Pkgdown/docs site:https://docs.ropensci.org

Datasets:
  • fq_attachments - A tibble of submission attachments.
  • fq_data - Parsed submission data for an ODK Central form.
  • fq_data_strata - Parsed submission data for a subgroup of an ODK Central form.
  • fq_data_taxa - Parsed submission data for a subgroup of an ODK Central form.
  • fq_form_detail - A tibble of form metadata.
  • fq_form_list - A tibble of forms.
  • fq_form_schema - JSON form schema for an ODK Central form.
  • fq_form_xml - A nested list of a form definition.
  • fq_meta - OData metadata document for an ODK Central form.
  • fq_project_detail - A tibble of project metadata.
  • fq_project_list - A tibble of project metadata.
  • fq_raw - OData submission data for an ODK Central form.
  • fq_raw_strata - OData submission data for a subgroup of an ODK Central form.
  • fq_raw_taxa - OData submission data for a subgroup of an ODK Central form.
  • fq_submission_list - A tibble of submission metadata.
  • fq_submissions - A nested list of submission data.
  • fq_svc - OData service document for an ODK Central form.
  • fq_zip_data - A tibble of the main data table of records from a test form.
  • fq_zip_strata - A tibble of a repeated sub-group of records from a test form.
  • fq_zip_taxa - A tibble of a repeated sub-group of records from a test form.
  • fs_v7 - The parsed XML form_schema of a form from ODK Central v0.6.
  • fs_v7_raw - The unparsed XML form_schema of a form from ODK Central v0.6 as nested list.
  • geo_fs - The form_schema of a form containing geofields in GeoJSON.
  • geo_gj - The parsed submissions of a form containing geofields in GeoJSON.
  • geo_gj_raw - The unparsed submissions of a form containing geofields in GeoJSON.
  • geo_gj88 - The parsed submissions of a form containing geofields in GeoJSON with trailing empty coordinates present.
  • geo_wkt - The parsed submissions of a form containing geofields in WKT.
  • geo_wkt_raw - The unparsed submissions of a form containing geofields in WKT.
  • geo_wkt88 - The parsed submissions of a form containing geofields in WKT with trailing empty coordinates present.

On CRAN:

Conda:

databaseopen-dataodkapidatadatasetodataodata-clientodk-centralopendatakit

6.13 score 45 stars 203 exports 58 dependencies

Last updated from:c700fc69e4 (on main). Checks:10 OK. Indexed: yes.

TargetResultTimeFilesSyslog
linux-develOK199
pkgdown docsOK298
source / vignettesOK370
linux-releaseOK197
macos-releaseOK155
macos-oldrelOK134
windows-develOK133
windows-releaseOK153
windows-oldrelOK146
wasm-releaseOK161

Exports:%>%app_user_createapp_user_deleteapp_user_listassignment_actorsassignment_grantassignment_listassignment_revokeattachment_deleteattachment_getattachment_linkattachment_listattachment_uploadaudit_getconfig_publicdrop_null_coordsencryption_key_listenexprenquoensymentity_auditsentity_bulk_deleteentity_bulk_restoreentity_changesentity_createentity_creatorsentity_deleteentity_detailentity_geodataentity_geojsonentity_listentity_restoreentity_updateentity_versionsentitylist_createentitylist_deleteentitylist_detailentitylist_downloadentitylist_listentitylist_property_createentitylist_property_deleteentitylist_trash_downloadentitylist_updateexprexprsform_assignment_actorsform_assignment_grantform_assignment_listform_assignment_revokeform_assignment_role_listform_attachment_downloadform_attachment_listform_createform_dataset_diffform_deleteform_detailform_draft_attachment_deleteform_draft_attachment_downloadform_draft_attachment_linkform_draft_attachment_listform_draft_attachment_uploadform_draft_createform_draft_dataset_diffform_draft_deleteform_draft_detailform_draft_publishform_draft_xlsxform_draft_xmlform_linkform_listform_restoreform_schemaform_schema_extform_schema_parseform_updateform_version_attachment_downloadform_version_attachment_listform_version_detailform_version_listform_version_xlsxform_version_xmlform_xlsxform_xmlget_default_fidget_default_odkc_versionget_default_ordersget_default_pidget_default_ppget_default_pwget_default_tzget_default_unget_default_urlget_one_attachmentget_one_submissionget_one_submission_att_listget_one_submission_auditget_retriesget_ru_verboseget_test_fidget_test_fid_attget_test_fid_gapget_test_fid_wktget_test_fid_zipget_test_odkc_versionget_test_pidget_test_ppget_test_pwget_test_unget_test_urlhandle_ru_attachmentshandle_ru_datetimeshandle_ru_geopointshandle_ru_geoshapeshandle_ru_geotracesodata_entitylist_data_getodata_entitylist_metadata_getodata_entitylist_service_getodata_metadata_getodata_service_getodata_submission_getodata_submission_rectangleodata_svc_parseparse_odkc_versionproject_assignment_actorsproject_assignment_grantproject_assignment_listproject_assignment_revokeproject_createproject_deleteproject_detailproject_enable_encryptionproject_listproject_replaceproject_updatepublic_link_createpublic_link_deletepublic_link_detailpublic_link_listpublic_link_updatequoquo_namequosrole_detailrole_listru_msg_abortru_msg_inforu_msg_noopru_msg_successru_msg_warnru_settingsru_setupsemver_gtsemver_ltsplit_geopointsplit_geoshapesplit_geotracesubmission_audit_getsubmission_changessubmission_comment_createsubmission_comment_listsubmission_createsubmission_csvsubmission_deletesubmission_detailsubmission_draft_attachment_deletesubmission_draft_attachment_downloadsubmission_draft_attachment_listsubmission_draft_attachment_uploadsubmission_draft_createsubmission_draft_exportsubmission_draft_getsubmission_draft_keyssubmission_draft_listsubmission_editsubmission_exportsubmission_geodatasubmission_geojsonsubmission_getsubmission_listsubmission_restoresubmission_reviewsubmission_submitterssubmission_updatesubmission_version_attachment_deletesubmission_version_attachment_downloadsubmission_version_attachment_listsubmission_version_detailsubmission_version_geojsonsubmission_version_xmlsubmission_versionssymsymsuser_createuser_deleteuser_detailuser_listuser_preference_project_deleteuser_preference_project_setuser_preference_site_deleteuser_preference_site_setuser_reset_passworduser_updateuser_update_password

Dependencies:askpassassertthatbitbit64clicliprcpp11crayoncredentialscurldescdplyrfsgenericsgertgitcredsgluehmshttr2inijanitorjsonlitelifecyclelubridatemagrittropensslpakpillarpkgconfigprettyunitsprogresspurrrR6rappdirsRcppreadrrlangrprojrootrstudioapisemversnakecasestringistringrsystibbletidyrtidyselecttimechangetzdbusethisutf8vctrsvroomwhiskerwithrxml2yamlzip

Comparison of related software packages
Comparison of ODK related software packages (non-ODK core) | Related tools beyond R | Comparison of OData related R packages
Rendered fromcomparison.Rmdusingknitr::rmarkdown

Last update: 2026-09-25
Started: 2020-09-08

Accessing the OData API
Configure ruODK | OData service document | OData metadata document | OData submission data documents | Detour: Data rectangling | DIY rectangling | Visualise data | Datatable | Map | Summarising data | Export | ruReady to ODK?
Rendered fromodata-api.Rmdusingknitr::rmarkdown

Last update: 2026-09-25
Started: 2019-11-25

Accessing the RESTful API
Scope | Three ways to happiness | Setup ruODK | Projects | Forms | List forms for a project | Inspect form schema | Show details of one form | Submissions | Get all submissions for one form | List submissions for one form | Get submission data | Parse submissions | Outlook
Rendered fromrestful-api.Rmdusingknitr::rmarkdown

Last update: 2026-09-25
Started: 2019-11-25

Setup
Configure ruODK | Best practice: ru_setup | Permanent defaults: Environment variables | The hard way: Per function call | Moving across forms | Legacy support for deprecated ODK Central features
Rendered fromsetup.Rmdusingknitr::rmarkdown

Last update: 2024-10-11
Started: 2019-07-22

Spatial data
Data | Map geopoints | Mapview using sf | GGplot using sf | Leaflet using sf | Leaflet using extracted coordinate components in tbl_df | Map geotraces (lines) | Leaflet using sf and extracted coordinates | Map geoshapes (polygons) | Outlook
Rendered fromspatial.Rmdusingknitr::rmarkdown

Last update: 2024-10-11
Started: 2020-08-07

Readme and manuals

Help Manual

Help pageTopics
Create a new App User.app_user_create
Delete an App User.app_user_delete
List all App Users of a Project.app_user_list
List all Actors assigned some server-wide Role.assignment_actors
Assign an Actor to a server-wide Role.assignment_grant
List all server-wide Assignments.assignment_list
Strip a server-wide Role Assignment from an Actor.assignment_revoke
Clear a Submission attachment.attachment_delete
Download attachments and return the local path.attachment_get
Prefix attachment columns from CSV export with a local attachment file path.attachment_link
List all attachments for a list of submission instances.attachment_list
Upload a Submission attachment.attachment_upload
Get server audit log entries.audit_get
Show publicly accessible server configuration.config_public
Drop any NULL coordinates from a GeoJSON geometry.drop_null_coords
List all encryption keys for a form.encryption_key_list
Return server audit logs of one Entity.entity_audits
Delete multiple Entities at once.entity_bulk_delete
Restore multiple deleted Entities at once.entity_bulk_restore
List changes to one Entity.entity_changes
Creates exactly one Entity in the Dataset.entity_create
List all creators of Entities in one Entity List.entity_creators
Delete one Entity.entity_delete
Show metadata and current data of one Entity.entity_detail
Get Entity geodata as GeoJSON.entity_geodata
Get the GeoJSON of one Entity.entity_geojson
List all Entities of a kind.entity_list
Restore a deleted Entity.entity_restore
Update one Entity.entity_update
List versions of one Entity.entity_versions
Create an Entity List.entitylist_create
Delete an Entity List.entitylist_delete
Show Entity List details.entitylist_detail
Download an Entity List as CSV.entitylist_download
List all Entity Lists of one Project.entitylist_list
Add a property to an Entity List.entitylist_property_create
Delete a property from an Entity List.entitylist_property_delete
Download Entities of a deleted Entity List.entitylist_trash_download
Update Entity List details.entitylist_update
List all Actors assigned some Form Role.form_assignment_actors
Assign an Actor to a Form Role.form_assignment_grant
Summarize all Form Assignments of one Project.form_assignment_list
Revoke a Form Role Assignment from an Actor.form_assignment_revoke
List Role-specific Form Assignments within a Project.form_assignment_role_list
Download one Form attachment.form_attachment_download
List all attachments of one Form.form_attachment_list
Create a new Form.form_create
Show Datasets affected by one Form.form_dataset_diff
Delete a Form.form_delete
Show details for one form.form_detail
Clear a Draft Form attachment.form_draft_attachment_delete
Download one Draft Form attachment.form_draft_attachment_download
Link a Dataset to a Draft Form attachment.form_draft_attachment_link
List all expected attachments of a Draft Form.form_draft_attachment_list
Upload a Draft Form attachment.form_draft_attachment_upload
Create a Draft Form.form_draft_create
Show Dataset changes of a Draft Form.form_draft_dataset_diff
Delete a Draft Form.form_draft_delete
Show details of a Draft Form.form_draft_detail
Publish a Draft Form.form_draft_publish
Download the XLSForm of a Draft Form.form_draft_xlsx
Show the XML of a Draft Form.form_draft_xml
Show Form details by Form Link ID.form_link
List all forms.form_list
Restore a deleted Form.form_restore
Show the schema of one form.form_schema
Show the extended schema of one form.form_schema_ext
Parse a form_schema into a tibble of fields with name, type, and path.form_schema_parse
Modify a Form's state.form_update
Download one attachment of a published Form version.form_version_attachment_download
List expected attachments of one published Form version.form_version_attachment_list
Show details of one published Form version.form_version_detail
List all published versions of one Form.form_version_list
Download the XLSForm of one published Form version.form_version_xlsx
Show the XML of one published Form version.form_version_xml
Download the XLSForm of one Form.form_xlsx
Show the XML representation of one form as list.form_xml
A tibble of submission attachments.fq_attachments
Parsed submission data for an ODK Central form.fq_data
Parsed submission data for a subgroup of an ODK Central form.fq_data_strata
Parsed submission data for a subgroup of an ODK Central form.fq_data_taxa
A tibble of form metadata.fq_form_detail
A tibble of forms.fq_form_list
JSON form schema for an ODK Central form.fq_form_schema
A nested list of a form definition.fq_form_xml
OData metadata document for an ODK Central form.fq_meta
A tibble of project metadata.fq_project_detail
A tibble of project metadata.fq_project_list
OData submission data for an ODK Central form.fq_raw
OData submission data for a subgroup of an ODK Central form.fq_raw_strata
OData submission data for a subgroup of an ODK Central form.fq_raw_taxa
A tibble of submission metadata.fq_submission_list
A nested list of submission data.fq_submissions
OData service document for an ODK Central form.fq_svc
A tibble of the main data table of records from a test form.fq_zip_data
A tibble of a repeated sub-group of records from a test form.fq_zip_strata
A tibble of a repeated sub-group of records from a test form.fq_zip_taxa
The parsed XML form_schema of a form from ODK Central v0.6.fs_v7
The unparsed XML form_schema of a form from ODK Central v0.6 as nested list.fs_v7_raw
The form_schema of a form containing geofields in GeoJSON.geo_fs
The parsed submissions of a form containing geofields in GeoJSON.geo_gj
The unparsed submissions of a form containing geofields in GeoJSON.geo_gj_raw
The parsed submissions of a form containing geofields in GeoJSON with trailing empty coordinates present.geo_gj88
The parsed submissions of a form containing geofields in WKT.geo_wkt
The unparsed submissions of a form containing geofields in WKT.geo_wkt_raw
The parsed submissions of a form containing geofields in WKT with trailing empty coordinates present.geo_wkt88
Download one media attachment.get_one_attachment
Download one submission.get_one_submission
List all attachments of one submission.get_one_submission_att_list
Download server audit logs for one submission.get_one_submission_audit
Download and link submission attachments according to a form schema.handle_ru_attachments
Parse datetimes of submission data according to a form schema.handle_ru_datetimes
Split all geopoints of a submission tibble into their components.handle_ru_geopoints
Split all geoshapes of a submission tibble into their components.handle_ru_geoshapes
Split all geotraces of a submission tibble into their components.handle_ru_geotraces
Get the Data Document from the OData Dataset Service.odata_entitylist_data_get
Get the Metadata Document from the OData Dataset Service.odata_entitylist_metadata_get
Get the Service Document from the OData Dataset Service.odata_entitylist_service_get
Retrieve metadata from an OData URL ending in .svc as list of lists.odata_metadata_get
Retrieve service metadata from an OData URL ending in .svc as tibble.odata_service_get
Retrieve and rectangle form submissions, parse dates, geopoints, download and link attachments.odata_submission_get
Rectangle the output of 'odata_submission_get(parse=FALSE)' into a tidy tibble and unnest all levels.odata_submission_rectangle
Retrieve URL, project ID, and form ID from an ODK Central OData service URL.odata_svc_parse
Parse a given ODK Central version string or number into a 'semver'.parse_odkc_version
List all Actors assigned some Project Role.project_assignment_actors
Assign an Actor to a Project Role.project_assignment_grant
List all Assignments of one Project.project_assignment_list
Revoke a Project Role Assignment from an Actor.project_assignment_revoke
Create a new project.project_create
Delete a Project.project_delete
List all details of one project.project_detail
Enable Project Managed Encryption.project_enable_encryption
List all projects.project_list
Replace a Project.project_replace
Modify a Project.project_update
Create a Public Access Link for one Form.public_link_create
Delete a Public Access Link.public_link_delete
Show details of one Public Access Link.public_link_detail
List all Public Access Links of one Form.public_link_list
Set Actor Property values on a Public Access Link.public_link_update
Show details of one Role.role_detail
List all Roles.role_list
Abort with an error message.ru_msg_abort
Print an info message.ru_msg_info
Print a noop message.ru_msg_noop
Print a success message.ru_msg_success
Signal a warning message.ru_msg_warn
Get or set 'ruODK' settings.get_default_fid get_default_odkc_version get_default_orders get_default_pid get_default_pp get_default_pw get_default_tz get_default_un get_default_url get_retries get_ru_verbose get_test_fid get_test_fid_att get_test_fid_gap get_test_fid_wkt get_test_fid_zip get_test_odkc_version get_test_pid get_test_pp get_test_pw get_test_un get_test_url ru_settings
Configure default 'ruODK' settings.ru_setup
Show whether a given semver is greater than a baseline version.semver_gt
Show whether a given semver is lesser than a baseline version.semver_lt
Annotate a dataframe containing a geopoint column with lon, lat, alt.split_geopoint
Annotate a dataframe containing a geoshape column with lon, lat, alt of the geotrace's first point.split_geoshape
Annotate a dataframe containing a geotrace column with lon, lat, alt of the geotrace's first point.split_geotrace
Get submission audits for a list of submission instance IDs.submission_audit_get
Show changes between versions of one Submission.submission_changes
Post a comment to one Submission.submission_comment_create
List all comments of one Submission.submission_comment_list
Create a Submission.submission_create
Export the root Submission table to CSV.submission_csv
Delete a Submission.submission_delete
Show metadata for one submission.submission_detail
Clear an attachment of a Draft Submission.submission_draft_attachment_delete
Download one attachment of a Draft Submission.submission_draft_attachment_download
List expected attachments of one Draft Submission.submission_draft_attachment_list
Upload an attachment of a Draft Submission.submission_draft_attachment_upload
Create a Submission on a Draft Form.submission_draft_create
Export Draft Submissions to CSV.submission_draft_export
Download one Draft Submission.submission_draft_get
List encryption keys of Draft Submissions.submission_draft_keys
List all Submissions of a Draft Form.submission_draft_list
Edit one Submission field and leave a comment.submission_edit
Export all form submissions including repeats and attachments to CSV.submission_export
Get Submissions geodata as GeoJSON.submission_geodata
Get the GeoJSON of one Submission.submission_geojson
Get submissions for a list of submission instance IDs.submission_get
List all submissions of one form.submission_list
Restore a deleted Submission.submission_restore
Review a Submission.submission_review
List all submitting Actors of one Form.submission_submitters
Update Submission data.submission_update
Clear one attachment of a Submission version.submission_version_attachment_delete
Download one attachment of a Submission version.submission_version_attachment_download
List expected attachments of one Submission version.submission_version_attachment_list
Show details of one Submission version.submission_version_detail
Get the GeoJSON of one Submission version.submission_version_geojson
Show the XML of one Submission version.submission_version_xml
List all versions of one Submission.submission_versions
Create a new User.user_create
Delete a User.user_delete
Show details of one User.user_detail
List all users.user_list
Delete a project preference of the authenticated User.user_preference_project_delete
Set a project preference of the authenticated User.user_preference_project_set
Delete a sitewide preference of the authenticated User.user_preference_site_delete
Set a sitewide preference of the authenticated User.user_preference_site_set
Initiate a User password reset.user_reset_password
Modify a User.user_update
Directly update a User password.user_update_password