R/data.R

In USAID-OHA-SI/tameDP: Import targets and PLHIV data from COP Target Setting Tool (formerly Data Pack)

#' Table of indicators and their disaggs
#'
#' A dataset containing the mapping between MER/SUBNAT/IMPATT indicators from
#' the Target Setting Tool and their official disaggregates in DATIM from FY23/
#' COP22 targets.
#'
#' @format A data frame with 60 rows and 4 variables:
#' \describe{
#'   \item{indicator}{MER indicator name}
#'   \item{numeratordenom}{designates whether the indicator type}
#'   \item{standardizeddisaggregate}{indicator disaggregation, eg Age/Sex/HIVStatus}
#'   \item{kp_disagg}{whether the disaggregation is for Key Populations}
#' }
#' @source \url{https://datim.zendesk.com/hc/en-us/articles/360001143166-DATIM-Data-Entry-Form-Screen-Shot-Repository}
"mer_disagg_mapping"

#' Table of MER indicators and disaggs including historic results disaggs
#'
#' A dataset containing the mapping between MER/SUBNAT/IMPATT indicators from
#' the Target Setting Tool and their official disaggregates in DATIM from FY23/
#' COP22 targets, as well as historic results/targets disaggregates from DATIM from
#' FY21-FY23.
#'
#' @format A data frame with 163 rows and 5 variables:
#' \describe{
#'   \item{indicator}{MER indicator name}
#'   \item{numeratordenom}{designates whether the indicator type}
#'   \item{standardizeddisaggregate}{indicator disaggregation, eg Age/Sex/HIVStatus}
#'   \item{fiscal_year}{fiscal year}
#'   \item{kp_disagg}{whether the disaggregation is for Key Populations}
#' }
#' @source \url{https://datim.zendesk.com/hc/en-us/articles/360001143166-DATIM-Data-Entry-Form-Screen-Shot-Repository}
"msd_historic_disagg_mapping"

#' Current Table of PEPFAR Operating Units and Counties
#'
#' A dataset containing the mapping countries and operating units. Most
#' countries are also Operating Units, expect for those in regional programs.
#'
#' @format A data frame with 60 rows and 2 variables:
#' \describe{
#'   \item{operatingunit}{PEPFAR Operating Unit (countries + 3 regional programs)}
#'   \item{country}{PEPFAR Country Name}
#' }
#' @source \url{https://final.datim.org/api/organisationUnits}
"ou_ctry_mapping"

#' Crosswalk to collapse age bands in MSD to match TST for COP23
#'
#' A dataframe containing the age bands in the MSD and the collapsed age bands in the COP23
#' Target Setting TOol
#'
#' @format A data frame with 18 rows and 2 variables:
#' \describe{
#'   \item{age_msd}{Age bands in the MER structured Dataset}
#'   \item{age_dp}{collapsed age bands in the TST}
#' }
"age_band_crosswalk"


#' Table of MER indicators and disaggs including historic results disaggs from 2024
#'
#' A dataset containing the mapping between MER/SUBNAT/IMPATT indicators from
#' the Target Setting Tool and their official disaggregates in DATIM from FY24/
#' COP23 targets, as well as historic results/targets disaggregates from DATIM from
#' FY22-FY24.
#'
#' @format A data frame with 225 rows and 5 variables:
#' \describe{
#'   \item{indicator}{MER indicator name}
#'   \item{numeratordenom}{designates whether the indicator type}
#'   \item{standardizeddisaggregate}{indicator disaggregation, eg Age/Sex/HIVStatus}
#'   \item{fiscal_year}{fiscal year}
#'   \item{kp_disagg}{whether the disaggregation is for Key Populations}
#' }
#' @source \url{https://datim.zendesk.com/hc/en-us/articles/360001143166-DATIM-Data-Entry-Form-Screen-Shot-Repository}
"mer_historic_disagg_mapping_2024"