dp.inputs.adult.art.adjustment.value: Extract inputs used to adjust programmatic numbers on ART for...

View source: R/extract-dp.R

dp.inputs.adult.art.adjustment.valueR Documentation

Extract inputs used to adjust programmatic numbers on ART for overcount or undercount

Description

Routine ART program data entered into Spectrum may be overcounted or undercounted for a variety of reasons. Countries may enter scale factors by year to adjust their program data up or down proportionally. These scale factors are entered seperately for adults and for children. Spectrum also has a TRUE/FALSE flag associated with adult and child adjustments. Spectrum will only adjust numbers on ART in a given year if this flag is TRUE, the number on ART is entered as an absolute number (not a percentage), and the scale factor value for that year is some value besides 1.

Usage

dp.inputs.adult.art.adjustment.value(
  dp.raw,
  direction = "wide",
  first.year = NULL,
  final.year = NULL
)

dp.inputs.adult.art.adjustment.flag(dp.raw, direction = "wide")

dp.inputs.child.art.adjustment.value(
  dp.raw,
  direction = "wide",
  first.year = NULL,
  final.year = NULL
)

dp.inputs.child.art.adjustment.flag(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

A data frame.

Functions

  • dp.inputs.adult.art.adjustment.value(): Adjustment values for adult ART by sex and year.

  • dp.inputs.adult.art.adjustment.flag(): TRUE if adult ART adjustments are enabled, FALSE otherwise.

  • dp.inputs.child.art.adjustment.value(): Adjustment values for child ART by year.

  • dp.inputs.child.art.adjustment.flag(): TRUE if child ART adjustments are enabled, FALSE otherwise.


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