View source: R/entitylist_list.R
entitylist_list | R Documentation |
entitylist_list(
pid = get_default_pid(),
url = get_default_url(),
un = get_default_un(),
pw = get_default_pw(),
retries = get_retries(),
odkc_version = get_default_odkc_version(),
orders = c("YmdHMS", "YmdHMSz", "Ymd HMS", "Ymd HMSz", "Ymd", "ymd"),
tz = get_default_tz()
)
pid |
The numeric ID of the project, e.g.: 2. Default: Set default See |
url |
The ODK Central base URL without trailing slash. Default: Set default See |
un |
The ODK Central username (an email address).
Default: |
pw |
The ODK Central password.
Default: |
retries |
The number of attempts to retrieve a web resource. This parameter is given to Default: 3. |
odkc_version |
The ODK Central version as a semantic version string
(year.minor.patch), e.g. "2023.5.1". The version is shown on ODK Central's
version page Default: Set default See |
orders |
(vector of character) Orders of datetime elements for lubridate. Default:
|
tz |
A timezone to convert dates and times to. Read |
While the API endpoint will return all Entity Lists for one Project,
entitylist_list
will fail with incorrect or missing
authentication.
An Entity List is a named collection of Entities that have the same properties. An Entity List can be linked to Forms as Attachments. This will make it available to clients as an automatically-updating CSV.
ODK Central calls Entity Lists internally Datasets. ruODK
chooses the term
Entity Lists as it is used in the ODK Central user interface and conveys
its relation to Entities better than the term Dataset.
This function is supported from ODK Central v2022.3 and will warn if the given odkc_version is lower.
A tibble with exactly one row for each dataset of the given project
as per ODK Central API docs.
Column names are renamed from ODK's camelCase
to snake_case
.
https://docs.getodk.org/central-api-dataset-management/#datasets
Other entity-management:
entitylist_detail()
,
entitylist_download()
## Not run:
# See vignette("setup") for setup and authentication options
# ruODK::ru_setup(svc = "....svc", un = "me@email.com", pw = "...")
ds <- entitylist_list(pid = get_default_pid())
ds |> knitr::kable()
## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.