Skip to contents

List all Entity Lists of one Project.

Source: R/entitylist_list.R
entitylist_list.Rd

[Maturing]

Usage

entitylist_list(
  pid = get_default_pid(),
  deleted = FALSE,
  url = get_default_url(),
  un = get_default_un(),
  pw = get_default_pw(),
  retries = get_retries(),
  odkc_version = get_default_odkc_version(),
  orders = get_default_orders(),
  tz = get_default_tz()
)

Arguments

pid

The numeric ID of the project, e.g.: 2.

Default: get_default_pid.

Set default pid through ru_setup(pid="...").

See vignette("Setup", package = "ruODK").

deleted

(lgl) If TRUE, list only deleted Entity Lists with their numeric IDs. Default: FALSE.

url

The ODK Central base URL without trailing slash.

Default: get_default_url.

Set default url through ru_setup(url="...").

See vignette("Setup", package = "ruODK").

un

The ODK Central username (an email address). Default: get_default_un. Set default un through ru_setup(un="..."). See vignette("Setup", package = "ruODK").

pw

The ODK Central password. Default: get_default_pw. Set default pw through ru_setup(pw="..."). See vignette("Setup", package = "ruODK").

retries

The number of attempts to retrieve a web resource.

This parameter is given to RETRY(times = retries).

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 /version.txt. Discard the "v". ruODK uses this parameter to adjust for breaking changes in ODK Central.

Default: get_default_odkc_version or "2023.5.1" if unset.

Set default get_default_odkc_version through ru_setup(odkc_version="2023.5.1").

See vignette("Setup", package = "ruODK").

orders

(vector of character) Orders of datetime elements for lubridate.

Default: c("YmdHMS", "YmdHMSz", "Ymd HMS", "Ymd HMSz", "Ymd", "ymd").

tz

A timezone to convert dates and times to.

Read vignette("setup", package = "ruODK") to learn how ruODK's timezone can be set globally or per function.

Value

A tibble with exactly one row for each Entity List of the given Project as per ODK Central API docs. Column names are renamed from ODK Central's camelCase to snake_case. With deleted = TRUE, the tibble holds one row per deleted Entity List with its numeric ID.

Details

The returned list is useful to retrieve the valid name of an Entity List for further use by functions of the Entity Management family.

With deleted = TRUE, only deleted Entity Lists with their numeric IDs are returned, which can be used to export a deleted Entity List with entitylist_trash_download().

See also

https://docs.getodk.org/central-api-dataset-management/#datasets

Other entity-management: entity_audits(), entity_bulk_delete(), entity_bulk_restore(), entity_changes(), entity_create(), entity_creators(), entity_delete(), entity_detail(), entity_geodata(), entity_geojson(), entity_list(), entity_restore(), entity_update(), entity_versions(), entitylist_create(), entitylist_delete(), entitylist_detail(), entitylist_download(), entitylist_property_create(), entitylist_property_delete(), entitylist_trash_download(), entitylist_update(), odata_entitylist_data_get(), odata_entitylist_metadata_get(), odata_entitylist_service_get(), print.odata_entitylist_data_get(), print.odata_entitylist_metadata_get(), print.odata_entitylist_service_get()

Examples

if (FALSE) { # \dontrun{
# 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()
} # }