dp.inputs.viral.suppression: Get viral suppression inputs

View source: R/extract-dp.R

dp.inputs.viral.suppressionR Documentation

Get viral suppression inputs

Description

Get viral suppression inputs

Usage

dp.inputs.viral.suppression(
  dp.raw,
  direction = "wide",
  first.year = NULL,
  final.year = NULL
)

dp.inputs.viral.suppression.threshold(
  dp.raw,
  direction = "wide",
  first.year = NULL,
  final.year = NULL
)

dp.inputs.viral.suppression.source(
  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()

Details

Some versions of Spectrum only allowed viral suppression data to be entered during 2010-2025. Data are not available in earlier or later years in files saved with these versions. Spectrum 6.29 and later can save data for every year in a projection, though countries may not input anything in most years.

Viral suppression inputs can be entered from household surveys ("Survey data") or from laboratory, programme, or case surveillance data ("Routine data"). dp.inputs.viral.suppression.source indicates which option was selected.

Value

A data frame.

Functions

  • dp.inputs.viral.suppression(): Numbers of people who had a viral load measured and numbers who were virally suppressed

  • dp.inputs.viral.suppression.threshold(): The threshold (in virus copies/mL) used to classify people as virally suppressed

  • dp.inputs.viral.suppression.source(): Indicates whether viral suppression data come from surveys or program data


rlglaubius/SpectrumUtils documentation built on Jan. 30, 2025, 3:25 a.m.