dp.inputs.adult.art: Get Spectrum adult ART inputs
In rlglaubius/SpectrumUtils: Utilities for reading Spectrum files (Title Case)

dp.inputs.adult.art

R Documentation

Get Spectrum adult ART inputs

Description

Get input numbers or percentages of adults on ART entered into Spectrum by sex and year in long or wide format

Usage

dp.inputs.adult.art(
  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.

Details

Adult treatment data can be entered into Spectrum as numbers or percentages. These units can vary from year to year. When direction="wide", the return value will include rows for numbers and for percentages, with percentages missing in years where numbers were entered or vice-versa. When direction="long", the data frame will include data for numbers or percentages, but not both, for any year.

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