Skip to contents

Retrieves Cervical Cancer Screening Data

Source: R/get_cervical_screened.R
get_cervical_screened.Rd

get_cervical_screened() retrieves cervical cancer screening data for a specified period from the KHIS API server.

Usage

get_cervical_screened(
  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 containing cervical cancer screening data with the following columns:

  • country - Name of the country.

  • county - Name of the county. Optional if the level is county, subcounty, ward or facility.

  • subcounty - Name of the subcounty. Optional if the level is subcounty, ward or facility.

  • ward - Name of the ward. Optional if the level is ward or facility.

  • facility - Name of the health facility. Optional if the level facility.

  • period - The month and year of the data.

  • fiscal_year- The financial year of the report(July-June Cycle).

  • year - The calendar year of the report.

  • month - The month name of the report.

  • category - The age group category of the report (<25, 25-49, 50+).

  • category2 - Additional category if available.

  • element - The data element (HPV, VIA or Pap Smear).

  • source - The source report (MOH 711 or MOH 745).

  • value - The number reported.

Examples

# Download data from February 2023 to current date
screened <- get_cervical_screened(start_date = '2023-02-01')
screened
#> # A tibble: 530 × 11
#>    value country element   category   period     month  year quarter fiscal_year
#>    <dbl> <chr>   <fct>     <fct>      <date>     <ord> <dbl> <fct>   <fct>      
#>  1     1 Kenya   HPV       Post-trea… 2024-05-01 May    2024 Q4      2023/2024  
#>  2   971 Kenya   Pap Smear Initial S… 2023-04-01 April  2023 Q4      2022/2023  
#>  3   106 Kenya   HPV       Routine S… 2024-01-01 Janu…  2024 Q3      2023/2024  
#>  4  1060 Kenya   Pap Smear Initial S… 2023-05-01 May    2023 Q4      2022/2023  
#>  5  1068 Kenya   Pap Smear Initial S… 2023-03-01 March  2023 Q3      2022/2023  
#>  6   464 Kenya   HPV       Routine S… 2024-02-01 Febr…  2024 Q3      2023/2024  
#>  7   638 Kenya   Pap Smear Initial S… 2023-08-01 Augu…  2023 Q1      2023/2024  
#>  8   651 Kenya   Pap Smear Initial S… 2023-07-01 July   2023 Q1      2023/2024  
#>  9  1331 Kenya   VIA       Initial S… 2023-09-01 Sept…  2023 Q1      2023/2024  
#> 10   895 Kenya   Pap Smear Initial S… 2023-06-01 June   2023 Q4      2022/2023  
#> # ℹ 520 more rows
#> # ℹ 2 more variables: age_group <fct>, source <fct>