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
orfacility
.subcounty - Name of the subcounty. Optional if the level is
subcounty
,ward
orfacility
.ward - Name of the ward. Optional if the level is
ward
orfacility
.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.