search

USAID-OHA-SI / mindthegap

Munges and returns estimates from UNAIDS data.
https://usaid-oha-si.github.io/mindthegap/
Other
5 stars 0 forks source link

readme

mindthegap

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

mindthegap was developed in 2019 in preparation for agency self assessments and COP to show UNAIDS 90-90-90 Progress and ART Gap. It has been turned into a package to process, clean, and export tidy UNAIDS Estimates data for ease of access.

Installing mindthegap

mindthegap 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('mindthegap', repos = c('https://usaid-oha-si.r-universe.dev', getOption("repos")))

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

  #load the package
    library(mindthegap)

## LIST TYPES OF STYLES INCLUDED WITH PACKAGE
  ls("package:mindthegap")

Example

The UNAIDS data reports on HIV estimates with uncertainty bounds from 1990 onward, and includes both epidemic control indicators and indicators that show progress to the 95s. The data is sourced from the UNAIDS AIDSInfo database, making it publicly accessible data. UNAIDS releases new estimates each July.

To access the core set of UNAIDS Data see the below example using pull_unaids().

This is a basic example of how to load the data using pull_unaids(). 

library(mindthegap)

df_est <- pull_unaids(data_type = "HIV Estimates", pepfar_only = TRUE)
df_tt <- pull_unaids(data_type = "HIV Test & Treat", pepfar_only = TRUE)

Additionally, data can be manually downloaded from the GitHub Releases page.

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.