Function reference • khisr

Authorization Credentials

Set and securely store the KHIS authorization credentials

khis_cred(): Sets the KHIS 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 KHIS API Base URI

with_khis_quiet() local_khis_quiet(): khisr Configuration

KHIS Metadata

Download metadata information from KHIS

get_metadata(): Get Metadata from a KHIS

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_dimensions() get_period_types(): 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

KHIS Analytics

To access analytical, aggregated data in KHIS

get_analytics(): Retrieves Analytics Table Data from KHIS

analytics_dimension() `%.d%` `%.f%`: Analytics Data Dimensions