Retrieves Reporting Metrics for Screening Tool

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
#> # A tibble: 17 × 12
#>    country dataset  period     month  year reporting_rate reporting_rate_on_time
#>    <chr>   <chr>    <date>     <ord> <dbl>          <dbl>                  <dbl>
#>  1 Kenya   MoH 745… 2023-06-01 June   2023           61.9                   57.9
#>  2 Kenya   MoH 745… 2023-05-01 May    2023           59.9                   56.5
#>  3 Kenya   MoH 745… 2023-03-01 March  2023           61.3                   54.7
#>  4 Kenya   MoH 745… 2024-05-01 May    2024           41.8                   41.8
#>  5 Kenya   MoH 745… 2024-06-01 June   2024            0                      0  
#>  6 Kenya   MoH 745… 2023-02-01 Febr…  2023           61.9                   52.2
#>  7 Kenya   MoH 745… 2023-04-01 April  2023           57.8                   51.6
#>  8 Kenya   MoH 745… 2024-03-01 March  2024           59.8                   57.8
#>  9 Kenya   MoH 745… 2024-04-01 April  2024           58                     56.6
#> 10 Kenya   MoH 745… 2023-07-01 July   2023           62.6                   56.1
#> 11 Kenya   MoH 745… 2023-10-01 Octo…  2023           61.1                   58  
#> 12 Kenya   MoH 745… 2024-01-01 Janu…  2024           58.8                   56  
#> 13 Kenya   MoH 745… 2024-02-01 Febr…  2024           60.5                   56.4
#> 14 Kenya   MoH 745… 2023-08-01 Augu…  2023           62.2                   58.7
#> 15 Kenya   MoH 745… 2023-09-01 Sept…  2023           62.2                   58  
#> 16 Kenya   MoH 745… 2023-11-01 Nove…  2023           59                     54.9
#> 17 Kenya   MoH 745… 2023-12-01 Dece…  2023           57.9                   55.3
#> # ℹ 5 more variables: actual_reports <dbl>, actual_reports_on_time <dbl>,
#> #   expected_reports <dbl>, quarter <fct>, fiscal_year <fct>