An R Client for the ODK Central API


[Up] [Top]

Documentation for package ‘ruODK’ version 0.9.10

Help Pages

attachment_get Download attachments and return the local path.
attachment_link Prefix attachment columns from CSV export with a local attachment file path.
attachment_list List all attachments for a list of submission instances.
audit_get Get server audit log entries.
drop_null_coords Drop any NULL coordinates from a GeoJSON geometry.
form_detail Show details for one form.
form_list List all forms.
form_schema Show the schema of one form.
form_schema_ext Show the extended schema of one form.
form_schema_parse Parse a form_schema into a tibble of fields with name, type, and path.
form_xml Show the XML representation of one form as list.
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_submissions A nested list of submission data.
fq_submission_list A tibble of submission metadata.
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.
get_default_fid Get or set 'ruODK' settings.
get_default_odkc_version Get or set 'ruODK' settings.
get_default_pid Get or set 'ruODK' settings.
get_default_pp Get or set 'ruODK' settings.
get_default_pw Get or set 'ruODK' settings.
get_default_tz Get or set 'ruODK' settings.
get_default_un Get or set 'ruODK' settings.
get_default_url Get or set 'ruODK' settings.
get_one_attachment Download one media attachment.
get_one_submission Download one submission.
get_one_submission_attachment_list List all attachments of one submission.
get_retries Get or set 'ruODK' settings.
get_ru_verbose Get or set 'ruODK' settings.
get_test_fid Get or set 'ruODK' settings.
get_test_fid_att Get or set 'ruODK' settings.
get_test_fid_gap Get or set 'ruODK' settings.
get_test_fid_wkt Get or set 'ruODK' settings.
get_test_fid_zip Get or set 'ruODK' settings.
get_test_odkc_version Get or set 'ruODK' settings.
get_test_pid Get or set 'ruODK' settings.
get_test_pp Get or set 'ruODK' settings.
get_test_pw Get or set 'ruODK' settings.
get_test_un Get or set 'ruODK' settings.
get_test_url Get or set 'ruODK' settings.
handle_ru_attachments Download and link submission attachments according to a form schema.
handle_ru_datetimes Parse datetimes of submission data according to a form schema.
handle_ru_geopoints Split all geopoints of a submission tibble into their components.
handle_ru_geoshapes Split all geoshapes of a submission tibble into their components.
handle_ru_geotraces Split all geotraces of a submission tibble into their components.
odata_metadata_get Retrieve metadata from an OData URL ending in .svc as list of lists.
odata_service_get Retrieve service metadata from an OData URL ending in .svc as tibble.
odata_submission_get Retrieve and rectangle form submissions, parse dates, geopoints, download and link attachments.
odata_submission_rectangle Rectangle the output of 'odata_submission_get(parse=FALSE)' into a tidy tibble and unnest all levels.
odata_svc_parse Retrieve URL, project ID, and form ID from an ODK Central OData service URL
project_create Create a new project.
project_detail List all details of one project.
project_list List all projects.
ru_msg_abort rlang::abort() with a red error message with a cross symbol.
ru_msg_info Print a blue info message with an info symbol.
ru_msg_noop Print a green noop message with a filled circle symbol.
ru_msg_success Print a green success message with a tick symbol.
ru_msg_warn rlang::warn() with a yellow warning message with a warning symbol.
ru_settings Get or set 'ruODK' settings.
ru_setup Configure default 'ruODK' settings.
split_geopoint Annotate a dataframe containing a geopoint column with lon, lat, alt.
split_geoshape Annotate a dataframe containing a geoshape column with lon, lat, alt of the geotrace's first point.
split_geotrace Annotate a dataframe containing a geotrace column with lon, lat, alt of the geotrace's first point.
submission_detail Show metadata for one submission.
submission_export Export all form submissions including repeats and attachments to CSV.
submission_get Get submissions for a list of submission instance IDs.
submission_list List all submissions of one form.