Package 'mindthegap'

Title: Mind the Gap: 90-90-90 Trends and ART Coverage Gaps
Description: Package to pull UNAIDS estimates as well as plot trends in UNAIDS 90-90-90 goals and ART coverage gap by country.
Authors: Aaron Chafetz [aut], Karishma Srikanth [aut, cre], Lemlem Baraki [aut], Tim Essam [aut]
Maintainer: Karishma Srikanth <[email protected]>
License: MIT + file LICENSE
Version: 1.1.2
Built: 2024-11-11 06:17:37 UTC
Source: https://github.com/USAID-OHA-SI/mindthegap

Help Index


95's Table Plot

Description

This function creates a summary table showing OU progress toward the 95-95-95's

Usage

base_plot(sel_base, sel_cntry)

Arguments

sel_base

Returns one of 2 table types eg "PLHIV", "Relative"

sel_cntry

PEPFAR country to visualize (list OU name)

Value

df_tt

Examples

## Not run: 
   base_plot(sel_base = "PLHIV", sel_cntry = "Lesotho")
   base_plot(sel_base = "Relative", sel_cntry = "Lesotho")

## End(Not run)

Epidemic Control Plot

Description

This function creates epidemic control curves for "ALL PEPFAR" or selected OU's

Usage

epi_plot(sel_cntry = c("All PEPFAR"))

Arguments

sel_cntry

PEPFAR country to visualize ("ALL PEPFAR" as default or list OU names)

df

UNAIDS based data frame

Value

Epidemic control plot showing trends in new infections and total deaths to HIV population

Examples

## Not run: 
   epi_plot()
   epi_plot(sel_cntry = "Lesotho")
   epi_plot(sel_cntry = c("South Africa", "Zambia", "Kenya", "Malawi"))
   epi_plot(sel_cntry = "USA") #breaks with non-PEPFAR countries

## End(Not run)

Load data for viz

Description

Deprecated

Usage

load_data(usaid_email = NULL)

Arguments

usaid_email

USAID email to store file on GDrive

Examples

## Not run: 
   load_data("[email protected]")
## End(Not run)

Cleaning UNAIDS Data

Description

(Updated July 2023)

This function fetches and cleans UNAIDS Estimates/Test and Treat Data

Usage

munge_unaids(return_type, indicator_type)

Arguments

return_type

Returns either 'HIV Estimates' or 'HIV Test & Treat' Data

indicator_type

Returns either 'Integer' or 'Percent' indicator values

Value

df

Examples

## Not run: 
   munge_unaids(return_type = "HIV Test & Treat", indicator_type = "Percent")

## End(Not run)

Pull clean UNAIDS HIV Estimates

Description

Pull clean UNAIDS estimates data. Wrapper around pull_unaids.

Usage

pull_estimates(pepfar_only = TRUE)

Arguments

pepfar_only

filters dataset to only PEPFAR countries if TRUE (default = TRUE)

Value

df

Examples

## Not run: 
   pull_estimates()

## End(Not run)

Pull clean UNAIDS HIV Test & Treat

Description

Pull clean UNAIDS 2022 (1990-2022) HIV Test & Treat data. Wrapper around pull_unaids.

Usage

pull_testtreat(pepfar_only = TRUE)

Arguments

pepfar_only

filters dataset to only PEPFAR countries if TRUE (default = TRUE)

Value

df

Examples

## Not run: 
   pull_testtreat()

## End(Not run)

Pull clean UNAIDS HIV Estimates and Test & Treat Data

Description

Pull clean UNAIDS estimates

Usage

pull_unaids(data_type, pepfar_only = TRUE)

Arguments

data_type

returns one of 2 available data set types eg "HIV Estimates", "HIV Test & Treat" (or both if missing)

pepfar_only

filters dataset to only PEPFAR countries if TRUE (default = TRUE)

Value

df

Examples

## Not run: 
   pull_unaids(data_type = "HIV Estimates", pepfar_only = TRUE)

## End(Not run)

UNAIDS Source Info

Description

Returns UNAIDS Source info for consistent sourcing notes

Usage

source_note

Format

An object of class character of length 1.


Generate UNAIDS headers

Description

Generate UNAIDS headers

Usage

unaids_hdrs()

Value

list of headers