dp.inputs.adult.hiv.mortality.art: HIV-related mortality rates among adults on ART

In rlglaubius/SpectrumUtils: Utilities for reading Spectrum files (Title Case)

HIV-related mortality rates among adults on ART

Description

HIV-related mortality rate inputs to Spectrum are stratified by age, sex, CD4 category, time on ART, and calendar year. Spectrum users may adjust a separate on-ART mortality scale factor to calibrate deaths on ART to vital registration data. Baseline rates by age, sex, CD4 and ART duration are accessed separately from mortality rate ratios over time and scale factors. Functions to access each of these are described below.

Usage

dp.inputs.adult.hiv.mortality.art(dp.raw, direction = "wide")

dp.inputs.adult.hiv.mortality.art.trend(
  dp.raw,
  direction = "wide",
  first.year = NULL,
  final.year = NULL
)

dp.inputs.adult.hiv.mortality.art.scale(dp.raw, direction = "wide")

Arguments

dp.raw	DemProj module data in raw format, as returned by read.raw.dp()
direction	Request "wide" (default) or "long" format data.
first.year	First year of the projection. If first.year=NULL, it will be filled in using dp.inputs.first.year()
final.year	Final year of the projection. If final.year=NULL, it will be filled in using dp.inputs.final.year()

Value

dp.inputs.adult.hiv.mortality.art returns a data frame.

dp.inputs.adult.hiv.mortality.art.trend returns a data frame.

dp.inputs.adult.hiv.mortality.art.scale returns scale factor.

Functions

• dp.inputs.adult.hiv.mortality.art(): Baseline HIV-related mortality rates on ART by sex, age, CD4 category, and time on ART.

• dp.inputs.adult.hiv.mortality.art.trend(): On-ART mortality rate ratios by year and ART duration.

• dp.inputs.adult.hiv.mortality.art.scale(): Scale factor applied to on-ART mortality rates.

rlglaubius/SpectrumUtils documentation built on Dec. 20, 2024, 7:31 a.m.