README.md

tameDP

Imports and tidies data from the PEPFAR, Excel-based Target Setting Tool (formerly known as the Data Pack) Historic versions available back to COP19.

R-CMD-check tameDP status badge Lifecycle: stable :name status badge

Installation

tameDP is not on CRAN, so you will have to install it directly from rOpenSci or GitHub using the code found below.

## SETUP

  #install from rOpenSci
    install.packages('tameDP', repos = c('https://usaid-oha-si.r-universe.dev', 'https://cloud.r-project.org'))

  #alt: install from GitHub using pak
    #install.packages("pak")
    #pak::pak("USAID-OHA-SI/tameDP")

  #load the package
    library(tameDP)

## List the functions available tameDP
  ls("package:tameDP")

Use

The main function of tameDP is to bring import a COP Target Setting Tool into R and make it tidy. The function aggregates the fiscal year targets up to the mechanism level, imports the mechanism information from DATIM, and breaks out the data elements to make the dataset more usable.

#load package
  library(tameDP)

#Target Setting Tool file path
  path <- "../Downloads/TargetSettingTool_Jupiter_20500101.xlsx"

#read in Target Setting Tool & tidy
 df_tst <- tame_dp(path)

#read in PLHIV and SUB_NAT data from the Target Setting Tool
 df_subnat <- tame_subnat(path)
#which is equivalent to 
  df_subnat2 <- tame_dp(path, type = "SUBNAT")

You can use one of the map() functions from purrr package to read in multiple Target Setting Tools and combine.

#load package
  library(purrr)
  library(getPass)

#identify all the Target Setting Tool files
  files <- list.files("../Downloads/DataPacks", full.names = TRUE)

#read in all Target Setting Tools and combine into one data frame
  df_all <- map_dfr(.x = files,
                    .f = ~ tame_dp(.x, map_names = FALSE))

#apply mech_name and primepartner names from DATIM
#you will need to provide your DATIM credentials 
  datim_user_nm <- "spower" #replace with your username
  datim_pwd <- getPass() #pop up prompting for your password
  df_all <- get_names(df_all, datim_user = datim_user_nm, datim_password = datim_pwd)

Disclaimer: The findings, interpretation, and conclusions expressed herein are those of the authors and do not necessarily reflect the views of United States Agency for International Development. All errors remain our own.



USAID-OHA-SI/tameDP documentation built on March 16, 2024, 6:26 a.m.