While the API endpoint will return all projects, project_list will fail with incorrect or missing authentication.

project_list(
  url = get_default_url(),
  un = get_default_un(),
  pw = get_default_pw(),
  retries = get_retries()
)

Arguments

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.

Value

A tibble with one row per project and all project metadata as columns as per ODK Central API docs.

Details

Stable lifecycle

See also

Examples

if (FALSE) { # Set default credentials, see vignette "setup" ruODK::ru_setup( svc = paste0( "https://sandbox.central.getodk.org/v1/projects/14/", "forms/build_Flora-Quadrat-0-2_1558575936.svc" ), un = "[email protected]", pw = "..." ) pl <- project_list() knitr::kable(pl) # project_list returns a tibble class(pl) # > "tbl_df" "tbl" "data.frame" # columns are project metadata names(pl) # > "id" "name" "forms" "app_users" "created_at" "updated_at" # > "last_submission" "archived" }