get_lab_bone_marrow {cancerscreening}R Documentation

Retrieves the Bone Marrow Laboratory Data

Description

get_lab_bone_marrow() retrieves bone marrow lab data for a specified period from the KHIS API server.

Usage

get_lab_bone_marrow(
  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 bone marrow lab data with the following columns:

Examples



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


[Package cancerscreening version 1.1.1 Index]