dp.inputs.child.art: Get Spectrum child HIV treatment inputs

View source: R/extract-dp.R

dp.inputs.child.artR Documentation

Get Spectrum child HIV treatment inputs

Description

Get input numbers or percentages of children on antiretroviral therapy (ART) or cotrimoxazole (CTX) prophylaxis entered into Spectrum by year and age in long or wide format

Usage

dp.inputs.child.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

Child treatment data can be entered into Spectrum as numbers or percentages for ages 0-14. Further, ART numbers can be entered by five-year age group (0-4, 5-9, or 10-14) instead. These units and age resolutions 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", unused combinations of age group, treatment, and unit are removed before returning.


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