R/data.R

In USAID-OHA-SI/gophr: Utility functions related to working with the MER Structured Dataset

#' MER Snapshot indicators
#'
#' List of indicators in the MER that are snapshot indicators, eg TX_CURR,
#' as opposed to a cumulative one, like HTS_TST. Snapshot indicators are handled
#' differently for calculating cumulative values and target achievement.
#'
#' @usage data(snapshot_ind)
#'
#' @format A list of all snapshot indicators
#' \describe{
#'   \item{snapshot_ind}{indicator names}
#' }

"snapshot_ind"


#' MER Clinical Cascade indicators
#'
#' List of indicators in the MER that comprise the clinical cascade. These
#' indicators are needed for calculating the 90s/95s plus linkage and viral load
#' coverage.
#'
#' @usage data(cascade_ind)
#'
#' @format A list of clinical cascade indicators
#' \describe{
#'   \item{cascade_ind}{indicator names}
#' }

"cascade_ind"

#' OHA Achievement Colors
#'
#' A tibble of the OHA Colors associated with different target achievement
#' thresholds - 'At Risk', 'Concerned', 'On Target', and 'Above Target'. This
#' table includes  the current mapping as well as the original/classic one.
#' These colors are used in association with `adorn_achievement`.
#'
#' @usage data(achv_color_map)
#'
#' @format A data frame with three variables and 4 rows
#' \describe{
#'   \item{achv_desc}{description of each achievement level}
#'   \item{achv_color}{hex code of the associated color to the achievement level}
#'   \item{achv_color_classic}{classic/original hex code of the associated color to the achievement level}
#' }

"achv_color_map"