An R Client to Retrieve Data from DHIS2

---

Documentation for package ‘khisr’ version 1.0.8

• DESCRIPTION file
• User guides, package vignettes and other documentation
• Package NEWS
• Package README

Help Pages

A G K L M T W misc

-- A --

analytics-dimension	Analytics Data Dimensions
analytics_dimension	Analytics Data Dimensions

-- G --

get_analytics	Retrieves Disaggregated Analytics Data from DHIS2
get_analytics_by_level	Retrieves Analytics Table Data
get_analytics_outliers	Get Statistical Outliers from DHIS2 Analytics
get_categories	DHIS2 Metadata Helper Functions
get_category_combos	DHIS2 Metadata Helper Functions
get_category_options	DHIS2 Metadata Helper Functions
get_category_option_combos	DHIS2 Metadata Helper Functions
get_category_option_groups	DHIS2 Metadata Helper Functions
get_category_option_group_sets	DHIS2 Metadata Helper Functions
get_complete_data_set_registrations	Get Raw Data Set Completeness Registrations from a DHIS2 Instance
get_data_elements	DHIS2 Metadata Helper Functions
get_data_elements_with_category_options	Get Data Elements with Category Options
get_data_element_groups	DHIS2 Metadata Helper Functions
get_data_element_group_sets	DHIS2 Metadata Helper Functions
get_data_sets	DHIS2 Metadata Helper Functions
get_data_sets_by_level	Retrieves Data Set Reporting Rate Metrics
get_data_store_keys	Get the Keys in a DHIS2 Data Store Namespace
get_data_store_namespaces	Get DHIS2 Data Store Namespaces
get_data_store_value	Get a Value from a DHIS2 Data Store
get_data_value_audits	Get Data Value Change History from a DHIS2 Instance
get_data_value_sets	Get Raw Data Values from a DHIS2 Instance
get_dimensions	DHIS2 Metadata Helper Functions
get_enrollments	Get Enrollments from a DHIS2 Instance
get_enrollment_analytics	Retrieves Aggregated Enrollment Analytics Data from DHIS2
get_enrollment_analytics_aggregate	Get Aggregated (Pivot-Style) Enrollment Analytics from DHIS2
get_events	Get Events from a DHIS2 Instance
get_event_analytics	Retrieves Aggregated Event Analytics Data from DHIS2
get_event_analytics_aggregate	Get Aggregated (Pivot-Style) Event Analytics from DHIS2
get_file_resources	Get File Resources Metadata from a DHIS2 Instance
get_geo_features	Get Organisation Unit Geographic Features
get_indicators	DHIS2 Metadata Helper Functions
get_indicator_groups	DHIS2 Metadata Helper Functions
get_indicator_group_sets	DHIS2 Metadata Helper Functions
get_metadata	Get Metadata from a DHIS2 Instance
get_options	DHIS2 Metadata Helper Functions
get_option_groups	DHIS2 Metadata Helper Functions
get_option_group_sets	DHIS2 Metadata Helper Functions
get_option_sets	DHIS2 Metadata Helper Functions
get_organisations_by_level	Get Organisations by Level
get_organisation_units	DHIS2 Metadata Helper Functions
get_organisation_unit_groups	DHIS2 Metadata Helper Functions
get_organisation_unit_groupsets	DHIS2 Metadata Helper Functions
get_organisation_unit_levels	DHIS2 Metadata Helper Functions
get_period_types	DHIS2 Metadata Helper Functions
get_programs	DHIS2 Metadata Helper Functions
get_program_stages	DHIS2 Metadata Helper Functions
get_relationships	Get Relationships from a DHIS2 Instance
get_relationship_types	DHIS2 Metadata Helper Functions
get_sql_views	Get SQL Views Metadata from a DHIS2 Instance
get_sql_view_data	Get Data from a DHIS2 SQL View
get_system_info	Get DHIS2 Instance System Information
get_tracked_entities	Get Tracked Entities from a DHIS2 Instance
get_tracked_entity_attributes	DHIS2 Metadata Helper Functions
get_tracked_entity_types	DHIS2 Metadata Helper Functions
get_user_groups	DHIS2 Metadata Helper Functions
get_user_profile	DHIS2 Metadata Helper Functions
get_validation_results	Get Validation Rule Results from DHIS2

-- K --

khisr-configuration	khisr Configuration
khis_api_version	Retrieve the Configured DHIS2 API Version
khis_base_url	Retrieve the Configured DHIS2 API Base URL
khis_cred	Sets DHIS2 Credentials
khis_cred_clear	Clear the Credentials from Memory
khis_display_name	Retrieve the Configured Display Name
khis_has_cred	Check if DHIS2 Credentials are Available
khis_username	Retrieve the Configured Username

-- L --

local_khis_quiet

khisr Configuration

-- M --

metadata-filter	Metadata Filter
metadata-helpers	DHIS2 Metadata Helper Functions
metadata_filter	Metadata Filter

-- T --

tracked_entity_filter

Tracked Entity Attribute Filter

-- W --

with_khis_quiet

khisr Configuration

-- misc --

%.d%	Analytics Data Dimensions
%.eq%	Metadata Filter
%.f%	Analytics Data Dimensions
%.ge%	Metadata Filter
%.gt%	Metadata Filter
%.ieq%	Metadata Filter
%.in%	Metadata Filter
%.le%	Metadata Filter
%.Like$%	Metadata Filter
%.like$%	Metadata Filter
%.Like%	Metadata Filter
%.like%	Metadata Filter
%.lt%	Metadata Filter
%.ne%	Metadata Filter
%.teq%	Tracked Entity Attribute Filter
%.tew%	Tracked Entity Attribute Filter
%.tge%	Tracked Entity Attribute Filter
%.tgt%	Tracked Entity Attribute Filter
%.tin%	Tracked Entity Attribute Filter
%.tle%	Tracked Entity Attribute Filter
%.tlike%	Tracked Entity Attribute Filter
%.tlt%	Tracked Entity Attribute Filter
%.tne%	Tracked Entity Attribute Filter
%.token%	Metadata Filter
%.tsw%	Tracked Entity Attribute Filter
%.^Like%	Metadata Filter
%.^like%	Metadata Filter
%.~eq%	Metadata Filter
%.~in%	Metadata Filter
%.~Like$%	Metadata Filter
%.~like$%	Metadata Filter
%.~Like%	Metadata Filter
%.~like%	Metadata Filter
%.~token%	Metadata Filter
%.~^Like%	Metadata Filter
%.~^like%	Metadata Filter