get_analytics_by_level: Retrieves Analytics Table Data

In khisr: An R Client to Retrieve Data from DHIS2

Retrieves Analytics Table Data

Description

get_analytics_by_level() fetches data from the DHIS2 analytics tables for a given period and data element(s), without performing any aggregation.

Usage

get_analytics_by_level(
  element_ids,
  start_date,
  end_date = NULL,
  level = 1,
  org_ids = NULL,
  ...,
  call = caller_env()
)

Arguments

element_ids	Required vector of data element IDs for which to retrieve data.
start_date	Required start date to retrieve data. It is required and in the format YYYY-MM-dd.
end_date	Optional ending date for data retrieval (default is the current date).
level	The desired organisation level of data (default: level 1)
org_ids	Optional list of organization units IDs to be filtered.
...	Other options that can be passed onto DHIS2 API.
call	The caller environment.

Details

• Retrieves data directly from DHIS2 analytics tables.

• Supports optional arguments for providing organization lists, data elements, and categories.

• Allows specifying DHIS2 session objects, retry attempts, and logging verbosity.

Value

A tibble with detailed information, including:

• Geographical identifiers (country, subnational, district, facility, depending on level)

• Reporting period (month, year, fiscal year)

• Data element names

• Category options

• Reported values

See Also

• get_organisations_by_level() for getting the organisations units

• get_data_elements_with_category_options() for retrieving the data elements

Examples

# Clinical Breast Examination data elements
# XEX93uLsAm2 = CBE Abnormal
# cXe64Yk0QMY = CBE Normal
element_id = c('cXe64Yk0QMY', 'XEX93uLsAm2')

# Download data from February 2023 to current date
data <- get_analytics_by_level(element_ids = element_id,
                               start_date = '2023-02-01')
data

khisr documentation built on Oct. 7, 2024, 1:11 a.m.