get_cervical_treated {cancerscreening} | R Documentation |
get_cervical_treated()
retrieves cervical cancer precancerous treatment
data for a specified period from the KHIS API server.
get_cervical_treated(
start_date,
end_date = NULL,
level = c("country", "county", "subcounty", "ward", "facility"),
organisations = NULL,
...
)
start_date |
The start date to retrieve data. It is required and in the format |
end_date |
The ending date for data retrieval (default is the current date). |
level |
The desired data granularity: |
organisations |
A list of organization units ids to be filtered. |
... |
Other options that can be passed onto KHIS API. |
A tibble containing cervical cancer precancerous treatment 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.
# Download data from February 2023 to current date
treated <- get_cervical_treated(start_date = '2023-02-01')
treated