get_analytics_formatted: Retrieves Analytics Table Data from KHIS

In cancerscreening: Streamline Access to Cancer Screening Data

Retrieves Analytics Table Data from KHIS

Description

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

Usage

get_analytics_formatted(
  element_ids,
  start_date,
  end_date = NULL,
  level = c("country", "county", "subcounty", "ward", "facility"),
  organisations = NULL,
  ...
)

Arguments

element_ids	A vector of data element IDs for which to retrieve data. Required.
start_date	The start date to retrieve data. It is required and in the format YYYY-MM-dd.
end_date	The ending date for data retrieval (default is the current date).
level	The desired data granularity: "country" (the default), "county", "subcounty", "ward", or "facility".
organisations	A list of organization units ids to be filtered.
...	Other options that can be passed onto KHIS API.

Details

• Retrieves data directly from KHIS analytics tables.

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

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

Value

A tibble with detailed information, including:

• Geographical identifiers (country, county, subcounty, ward, facility, depending on level)

• Reporting period (month, year, fiscal year)

• Data element names

• Category options

• Reported values

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_formatted(element_ids = element_id,
                                start_date = '2023-02-01')
data

cancerscreening documentation built on June 22, 2024, 9:09 a.m.