tidyndr (version 0.2.1)

vl_cascade: Analyse the Viral Load Cascade Indicators

Description

Generate aggregate summary of viral load indicators based on a referenced date. The indicators include eligible, documented results, virally suppressed, viral load coverage, and viral load suppression rate.

Usage

vl_cascade(
  data,
  ref = NULL,
  states = NULL,
  facilities = NULL,
  status = "default",
  n = 1000,
  use_six_months = TRUE,
  remove_duplicates = FALSE,
  .level = "state",
  .names = NULL
)

Arguments

data

An NDR dataframe imported using the `read_ndr().

ref

Date provided in ISO8601 format ("yyyy-mm-dd"). Used to determine clients who are eligible for viral load and should have a documented result. The default is the date of analysis.

states

The name(s) of the State(s) of interest. The default utilizes all the states in the dataframe. If specifying more than one state, combine the states using the c() e.g. c("State 1", "State 2").

facilities

The name(s) of the facilit(ies) of interest. Default is to utilize all the facilities contained in the dataframe. If specifying more than one facility, combine the facilities using the c() e.g. c("Facility 1", "Facility 2").

status

Determines how the number of active clients is calculated. The options are to either to use the NDR current_status_28_days column or the derived current_status column ("calculated").

n

the value below which viral load result is adjudged to be suppressed.

use_six_months

TRUE of FALSE. To determine if six months eligibility should be used for pediatrics and adolescents repeat viral load or the standard annual repeat.

remove_duplicates

Boolean argument. It specifies if duplicate patient entries in the facilities should be removed or kept

.level

the level at which the aggregate summary should be performed. The options are "ip", "country", "state", "lga" and "facility".

.names

if specified, these will be used for naming of the viral load indicators instead of the default.

Value

summary of viral load cascade

Examples

# NOT RUN {
vl_cascade(ndr_example, ref = "2021-12-31", .level = "state")

# Determine the viral load cascade for a state at the end of September 2021
vl_cascade(ndr_example,
  ref = "2021-10-31",
  states = "Arewa"
)

# }