dp.inputs.csavr.deaths.source: Get input numbers of AIDS deaths used by CSAVR to estimate...

View source: R/extract-dp.R

dp.inputs.csavr.deaths.sourceR Documentation

Get input numbers of AIDS deaths used by CSAVR to estimate HIV incidence

Description

Spectrum's Case Surveillance and Vital Registration (CSAVR) tool uses case surveillance data on new HIV diagnoses and vital registration data on AIDS deaths in adults to estimate HIV incidence. AIDS deaths can be entered overall, by sex, or by sex and age. Countries may use AIDS deaths data from their vital registration system or AIDS deaths estimates produced by the Institute of Health Metrics and Evaluation (IHME) in CSAVR. Current Spectrum versions allow users to enter data from up to three different sources, then select which source would be used for fitting. Older versions of Spectrum only allowed users to enter one source of data.

Usage

dp.inputs.csavr.deaths.source(dp.raw, direction = "wide")

dp.inputs.csavr.deaths.source.names(dp.raw, direction = "wide")

dp.inputs.csavr.deaths(
  dp.raw,
  direction = "wide",
  first.year = NULL,
  final.year = NULL
)

dp.inputs.csavr.deaths.sex(
  dp.raw,
  direction = "wide",
  first.year = NULL,
  final.year = NULL
)

dp.inputs.csavr.deaths.sex.age(
  dp.raw,
  direction = "wide",
  first.year = NULL,
  final.year = NULL
)

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

a data frame

Functions

  • dp.inputs.csavr.deaths.source(): The data source selected for use in CSAVR.

  • dp.inputs.csavr.deaths.source.names(): User-specified name for each source of AIDS deaths data entered into CSAVR.

  • dp.inputs.csavr.deaths(): Adult AIDS deaths by year and data source.

  • dp.inputs.csavr.deaths.sex(): Adult AIDS deaths by year, sex, and data source.

  • dp.inputs.csavr.deaths.sex.age(): Adult AIDS deaths by year, sex, age, and data source.


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