get_lab_smears() retrieves cytology smears lab data for a specified period
from the KHIS API server.
Usage
get_lab_smears(
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 cytology smears lab data with the following columns:
country - Name of the country.
county - Name of the county. Optional if the level is
county,subcounty,wardorfacility.subcounty - Name of the subcounty. Optional if the level is
subcounty,wardorfacility.ward - Name of the ward. Optional if the level is
wardorfacility.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
element - The data element.
value - The number reported.
Examples
# Download data from February 2023 to current date
data <- get_lab_smears(start_date = '2023-02-01')
data
#> # A tibble: 96 × 10
#> value country element category period month year quarter fiscal_year
#> <dbl> <chr> <fct> <fct> <date> <ord> <dbl> <fct> <fct>
#> 1 1280 Kenya PAP smear Total E… 2024-01-01 Janu… 2024 Q3 2023/2024
#> 2 3141 Kenya PAP smear Total E… 2024-02-01 Febr… 2024 Q3 2023/2024
#> 3 190 Kenya Tissue imp… Total E… 2024-03-01 March 2024 Q3 2023/2024
#> 4 1610 Kenya PAP smear Total E… 2024-03-01 March 2024 Q3 2023/2024
#> 5 9 Kenya Touch prep… Maligna… 2023-03-01 March 2023 Q3 2022/2023
#> 6 3 Kenya Tissue imp… Total E… 2024-04-01 April 2024 Q4 2023/2024
#> 7 1085 Kenya PAP smear Total E… 2024-05-01 May 2024 Q4 2023/2024
#> 8 692 Kenya PAP smear Total E… 2024-04-01 April 2024 Q4 2023/2024
#> 9 194 Kenya Tissue imp… Total E… 2024-01-01 Janu… 2024 Q3 2023/2024
#> 10 0 Kenya Touch prep… Maligna… 2023-02-01 Febr… 2023 Q3 2022/2023
#> # ℹ 86 more rows
#> # ℹ 1 more variable: source <chr>