Metadata Helper Functions

Wrappers for get_metadata() that retrieves data from a specific KHIS API endpoint.

Usage

get_categories(..., fields = c("id", "name"))

get_category_combos(..., fields = c("id", "name"))

get_category_option_combos(..., fields = c("id", "name"))

get_category_option_group_sets(..., fields = c("id", "name"))

get_category_option_groups(..., fields = c("id", "name"))

get_category_options(..., fields = c("id", "name"))

get_data_element_group_sets(..., fields = c("id", "name"))

get_data_element_groups(..., fields = c("id", "name"))

get_data_elements(..., fields = c("id", "name"))

get_data_sets(..., fields = c("id", "name"))

get_user_groups(..., fields = c("id", "name"))

get_indicator_group_sets(..., fields = c("id", "name"))

get_indicator_groups(..., fields = c("id", "name"))

get_indicators(..., fields = c("id", "name"))

get_option_group_sets(..., fields = c("id", "name"))

get_option_groups(..., fields = c("id", "name"))

get_option_sets(..., fields = c("id", "name"))

get_options(..., fields = c("id", "name"))

get_organisation_unit_groupsets(..., fields = c("id", "name"))

get_organisation_unit_groups(..., fields = c("id", "name"))

get_organisation_units(..., fields = c("id", "name"))

get_dimensions(..., fields = c("id", "name"))

get_period_types(..., fields = c("id", "name"))

Arguments

...

Arguments passed on to get_metadata

retry

Number of times to retry the API call in case of failure (defaults to 2).

verbosity

Level of HTTP information to print during the call:

• 0: No output

• 1: Show headers

• 2: Show headers and bodies

• 3: Show headers, bodies, and CURL status message.

timeout

Maximum number of seconds to wait for the API response.

fields

The specific columns to be returned in the tibble.

Value

A tibble with the KHIS metadata response.

Examples

if (FALSE) { # khis_has_cred()

# Get all organisation units
get_organisation_units()

# Get all data elements
get_data_elements()

# Get data elements by element ids
get_data_elements(id %.in% c('VR7vdS7P0Gb', 'gQro1y7Rsbq'))

# Get datasets by name with the word 'MOH 705'
get_data_sets(name %.like% 'MOH 705')
}