get_screening_reporting_analytics {cancerscreening}

Retrieves Reporting Metrics for Screening Tool

Description

get_screening_reporting_analytics() It fetches the reporting metrics for the screening tool (MOH 745).

Usage

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

Arguments

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.

Value

A tibble with the reporting metrics.

Examples

# Download screening metric from February 2023 to current date
data <- get_screening_reporting_analytics(start_date = '2023-02-01')
data