Skip to contents

Retrieves Cervical Cancer Screening Data with Positive Results

Source: R/get_cervical_positive.R
get_cervical_positive.Rd

get_cervical_positive() retrieves cervical cancer screening data with positive results for a specified period from the KHIS API server.

Usage

get_cervical_positive(
  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 positive results 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
positive <- get_cervical_positive(start_date = '2023-02-01')
positive
#> # A tibble: 605 × 11
#>    value country element     category period     month  year quarter fiscal_year
#>    <dbl> <chr>   <fct>       <fct>    <date>     <ord> <dbl> <fct>   <fct>      
#>  1    11 Kenya   Suspicious… Initial… 2023-12-01 Dece…  2023 Q2      2023/2024  
#>  2    46 Kenya   HPV         NA       2024-04-01 April  2024 Q4      2023/2024  
#>  3    30 Kenya   HPV         NA       2024-02-01 Febr…  2024 Q3      2023/2024  
#>  4    16 Kenya   VIA         Post-tr… 2024-01-01 Janu…  2024 Q3      2023/2024  
#>  5    17 Kenya   HPV         NA       2024-05-01 May    2024 Q4      2023/2024  
#>  6    34 Kenya   HPV         NA       2024-01-01 Janu…  2024 Q3      2023/2024  
#>  7    64 Kenya   VIA         Initial… 2023-10-01 Octo…  2023 Q2      2023/2024  
#>  8    27 Kenya   Suspicious… Initial… 2023-10-01 Octo…  2023 Q2      2023/2024  
#>  9     3 Kenya   HPV         NA       2023-11-01 Nove…  2023 Q2      2023/2024  
#> 10    14 Kenya   Suspicious… Initial… 2023-11-01 Nove…  2023 Q2      2023/2024  
#> # ℹ 595 more rows
#> # ℹ 2 more variables: age_group <fct>, source <fct>