get_cervical_positive {cancerscreening}R Documentation

Retrieves Cervical Cancer Screening Data with Positive Results

Description

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:

Examples


# Download data from February 2023 to current date
positive <- get_cervical_positive(start_date = '2023-02-01')
positive


[Package cancerscreening version 1.1.1 Index]