Package: ruODK 1.5.1

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.5.1.tar.gz
ruODK_1.5.1.zip(r-4.5)ruODK_1.5.1.zip(r-4.4)ruODK_1.5.1.zip(r-4.3)
ruODK_1.5.1.tgz(r-4.4-any)ruODK_1.5.1.tgz(r-4.3-any)
ruODK_1.5.1.tar.gz(r-4.5-noble)ruODK_1.5.1.tar.gz(r-4.4-noble)
ruODK_1.5.1.tgz(r-4.4-emscripten)ruODK_1.5.1.tgz(r-4.3-emscripten)
ruODK.pdf |ruODK.html✨
ruODK/json (API)
NEWS

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

Peer review:

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

Pkgdown 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_gj88 - The parsed submissions of a form containing geofields in GeoJSON with trailing empty coordinates present.
  • geo_gj_raw - The unparsed submissions of a form containing geofields in GeoJSON.
  • geo_wkt - The parsed 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.
  • geo_wkt_raw - The unparsed submissions of a form containing geofields in WKT.

On CRAN:

databaseopen-dataodkapidatadatasetodataodata-clientodk-centralopendatakit

7.87 score 42 stars 1 packages 56 scripts 96 exports 48 dependencies

Last updated 2 months agofrom:94345cd4f4 (on main). Checks:OK: 1 NOTE: 6. Indexed: yes.

TargetResultDate
Doc / VignettesOKDec 06 2024
R-4.5-winNOTEDec 06 2024
R-4.5-linuxNOTEDec 06 2024
R-4.4-winNOTEDec 06 2024
R-4.4-macNOTEDec 06 2024
R-4.3-winNOTEDec 06 2024
R-4.3-macNOTEDec 06 2024

Exports:%>%attachment_getattachment_linkattachment_listaudit_getdrop_null_coordsencryption_key_listenexprenquoensymentity_auditsentity_changesentity_createentity_deleteentity_detailentity_listentity_updateentity_versionsentitylist_detailentitylist_downloadentitylist_listentitylist_updateexprexprsform_detailform_listform_schemaform_schema_extform_schema_parseform_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_createproject_detailproject_listquoquo_namequosru_msg_abortru_msg_inforu_msg_noopru_msg_successru_msg_warnru_settingsru_setupsemver_gtsemver_ltsplit_geopointsplit_geoshapesplit_geotracesubmission_audit_getsubmission_detailsubmission_exportsubmission_getsubmission_listsymsymsuser_list

Dependencies:askpassassertthatbitbit64clicliprclisymbolscpp11crayoncurldplyrfansifsgenericsgluehmshttrjanitorjsonlitelifecyclelubridatemagrittrmimeopensslpillarpkgconfigprettyunitsprogresspurrrR6Rcppreadrrlangsemversnakecasestringistringrsystibbletidyrtidyselecttimechangetzdbutf8vctrsvroomwithrxml2

Accessing the OData API

Rendered fromodata-api.Rmdusingknitr::rmarkdownon Dec 06 2024.

Last update: 2024-10-11
Started: 2019-11-25

Accessing the RESTful API

Rendered fromrestful-api.Rmdusingknitr::rmarkdownon Dec 06 2024.

Last update: 2024-10-11
Started: 2019-11-25

Comparison of related software packages

Rendered fromcomparison.Rmdusingknitr::rmarkdownon Dec 06 2024.

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

Setup

Rendered fromsetup.Rmdusingknitr::rmarkdownon Dec 06 2024.

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

Spatial data

Rendered fromspatial.Rmdusingknitr::rmarkdownon Dec 06 2024.

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

Readme and manuals

Help Manual

Help pageTopics
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
Get server audit log entries.audit_get
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
List changes to one Entity.entity_changes
Creates exactly one Entity in the Dataset.entity_create
Delete one Entity.entity_delete
Show metadata and current data of one Entity.entity_detail
List all Entities of a kind.entity_list
Update one Entity.entity_update
List versions of one Entity.entity_versions
Show Entity List details.entitylist_detail
Download an Entity List as CSV.entitylist_download
List all Entity Lists of one Project.entitylist_list
Update Entity List details.entitylist_update
Show details for one form.form_detail
List all forms.form_list
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
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
Create a new project.project_create
List all details of one project.project_detail
List all projects.project_list
rlang::abort() with a red error message with a cross symbol.ru_msg_abort
Print a blue info message with an info symbol.ru_msg_info
Print a green noop message with a filled circle symbol.ru_msg_noop
Print a green success message with a tick symbol.ru_msg_success
rlang::warn() with a yellow warning message with a warning symbol.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 metadata for one submission.submission_detail
Export all form submissions including repeats and attachments to CSV.submission_export
Get submissions for a list of submission instance IDs.submission_get
List all submissions of one form.submission_list
List all users.user_list