Function reference

Authorization Credentials

Set and securely store the DHIS2 authorization credentials

khis_cred()

Sets DHIS2 Credentials

khis_has_cred()

Are There Credentials on Hand?

khis_cred_clear()

Clear the Credentials from Memory

khis_username()

Produces the Configured Username

khis_base_url()

Produces the Configured DHIS2 API Base URI

with_khis_quiet() local_khis_quiet()

khisr Configuration

DHIS2 Metadata

Download metadata information from DHIS2

get_metadata()

Get Metadata from a DHIS2 Instance

get_categories() get_category_combos() get_category_option_combos() get_category_option_group_sets() get_category_option_groups() get_category_options() get_data_element_group_sets() get_data_element_groups() get_data_elements() get_data_sets() get_user_groups() get_indicator_group_sets() get_indicator_groups() get_indicators() get_option_group_sets() get_option_groups() get_option_sets() get_options() get_organisation_unit_groupsets() get_organisation_unit_groups() get_organisation_units() get_organisation_unit_levels() get_dimensions() get_period_types() get_user_profile()

DHIS2 Metadata Helper Functions

metadata_filter() `%.eq%` `%.ieq%` `%.~eq%` `%.ne%` `%.Like%` `%.~Like%` `%.^Like%` `%.~^Like%` `%.Like$%` `%.~Like$%` `%.like%` `%.~like%` `%.^like%` `%.~^like%` `%.like$%` `%.~like$%` `%.gt%` `%.ge%` `%.lt%` `%.le%` `%.token%` `%.~token%` `%.in%` `%.~in%`

Metadata Filter

DHIS2 Analytics

To access analytical, aggregated data in DHIS2

get_analytics()

Retrieves Disaggregated Analytics Data from a DHIS2 Server

analytics_dimension() `%.d%` `%.f%`

Analytics Data Dimensions

Experimental Functions

Experimental functions that formats the data in logical manner

get_analytics_by_level()

Retrieves Analytics Table Data

get_data_elements_with_category_options()

Get Data Elements with Category Options

get_data_sets_by_level()

Retrieves Data Set Reporting Rate Metrics

get_organisations_by_level()

Get Organisations by Level