![](../logo.png)
Retrieves Data for Breast Ultrasound Conducted
Source:R/get_breast_ultrasound.R
get_breast_ultrasound.Rd
get_breast_ultrasound()
retrieves data for breast ultrasounds conducted within a
specified period from the KHIS API server.
Usage
get_breast_ultrasound(
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 data for breast ultrasound conducted 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-34, 35-39, 40-55, 56-74, or 75+).
category2 - Additional category if available.
element - The data element.
value - The number reported.
Examples
# Download data from February 2023 to current date
ultrasound_data <- get_breast_ultrasound(start_date = '2023-02-01')
ultrasound_data
#> # A tibble: 207 × 11
#> value country element age_group period month year quarter fiscal_year
#> <dbl> <chr> <fct> <fct> <date> <ord> <dbl> <fct> <fct>
#> 1 293 Kenya BIRADS 0-3 25-34 2023-12-01 Dece… 2023 Q2 2023/2024
#> 2 368 Kenya BIRADS 0-3 25-34 2023-11-01 Nove… 2023 Q2 2023/2024
#> 3 9 Kenya BIRADS 0-3 56-74 2023-03-01 March 2023 Q3 2022/2023
#> 4 18 Kenya BIRADS 0-3 56-74 2023-05-01 May 2023 Q4 2022/2023
#> 5 2 Kenya BIRADS 0-3 75+ 2024-02-01 Febr… 2024 Q3 2023/2024
#> 6 4 Kenya BIRADS 0-3 75+ 2024-04-01 April 2024 Q4 2023/2024
#> 7 296 Kenya BIRADS 0-3 25-34 2023-10-01 Octo… 2023 Q2 2023/2024
#> 8 39 Kenya BIRADS 4 25-34 2024-01-01 Janu… 2024 Q3 2023/2024
#> 9 1 Kenya BIRADS 0-3 75+ 2024-03-01 March 2024 Q3 2023/2024
#> 10 23 Kenya BIRADS 0-3 56-74 2023-08-01 Augu… 2023 Q1 2023/2024
#> # ℹ 197 more rows
#> # ℹ 2 more variables: source <chr>, category <fct>