dp.inputs.incidence.model: Get the model used to estimate incidence in a Spectrum...

View source: R/extract-dp.R

dp.inputs.incidence.modelR Documentation

Get the model used to estimate incidence in a Spectrum projection

Description

Get the model used to estimate incidence in a Spectrum projection

Usage

dp.inputs.incidence.model(dp.raw, direction = "wide")

Arguments

dp.raw

DemProj module data in raw format, as returned by read.raw.dp()

direction

Ignored; included for compatibility with similar functions.

Value

The incidence model name as a factor (see "Details" below for factor levels)

Details

Spectrum can take HIV incidence from several different models as inputs:

  1. Direct - manually entered incidence values by year

  2. EPP - the Estimation and Projection Package

  3. AEM - the AIDS Epidemic Model

  4. CSAVR - the Case Surveillance and Vital Registration tool

  5. Mortality - incidence calibrated to mortality data

  6. ECDC - The European Centre for Disease Prevention and Control's HIV Modelling Tool

dp.inputs.incidence.model() returns the name of the model used as a factor. Use dp.inputs.incidence() to get the incidence trend itself.


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