tidyndr (version 0.2.1)

tx_regimen: Subset Clients Based on their Current ART Regimen

Description

Generates the line-list of clients on first-line regimen who are on the choice combination regimen for their age or weight. The NDR does not currently report 'weight' so the function uses 'age' to approximate the choice-regimen for the clients.

Usage

tx_regimen(
  data,
  age_band = NULL,
  states = NULL,
  facilities = NULL,
  status = "default",
  remove_duplicates = FALSE
)

Arguments

data

An NDR dataframe imported using the `read_ndr()

age_band

a numeric vector of length 2 c(min_age, max_age).

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").

remove_duplicates

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

Value

tx_regimen

Examples

# NOT RUN {
tx_regimen(ndr_example)

tx_regimen(ndr_example,
  status = "default",
  age_band = c(0, 3)
)
# }