tidyndr (version 0.2.1)

cot_cascade: Analyse the Treatment Continuity Cascade

Description

Generate aggregate summary of treatment continuity indicators based on a specified quarter. The indicators include tx_curr (previous quarter), tx_new, tx_ml, tx_ml_dead, tx_ml_to, tx_ml_iit, and iit_rate.

Usage

cot_cascade(
  data,
  quarter = NULL,
  ref = NULL,
  states = NULL,
  facilities = NULL,
  status = "default",
  remove_duplicates = FALSE,
  .level = "state",
  .names = NULL
)

Arguments

data

An NDR dataframe imported using the read_ndr().

quarter

the quarter of the fiscal year for which the treatment continuity indicators should be calculated.

ref

the referenced date for the analysis. If this is not set (i.e. NULL) it will be assumed to be the last day of the quarter.

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

.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 treatment continuity indicators

Examples

# NOT RUN {
cot_cascade(ndr_example, quarter = 2, ref = "2022-02-28", .level = "state")

# Determine the treatment continuity cascade for a state at the end of quarter one of FY22
cot_cascade(ndr_example,
  quarter = 1,
  states = "Arewa"
)

# }