Skip to contents

Retrieves Analytics Table Data from KHIS

Source: R/get_analytics.R
get_analytics.Rd

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

Usage

get_analytics(
  ...,
  return_type = c("uid", "name"),
  retry = 2,
  verbosity = 0,
  timeout = 60
)

Arguments

...

One or more analytics_dimension() in key-value pairs.

return_type

The type to be return names of uid.

retry

Number of times to retry the API call in case of failure (defaults to 2).

verbosity

Level of HTTP information to print during the call:

  • 0: No output

  • 1: Show headers

  • 2: Show headers and bodies

  • 3: Show headers, bodies, and CURL status message.

timeout

Maximum number of seconds to wait for the API response.

Value

A tibble with detailed information

Details

  • Retrieves data directly from KHIS analytics tables.

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

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(dx %.d% element_id, pe %.d% 'LAST_MONTH')
data
#> # A tibble: 2 × 3
#>   dx          pe     value
#>   <chr>       <chr>  <dbl>
#> 1 cXe64Yk0QMY 202403 46882
#> 2 XEX93uLsAm2 202403  3447