dp.inputs.survey.hiv.prevalence: Get HIV prevalence data entered from household surveys

In rlglaubius/SpectrumUtils: Utilities for reading Spectrum files (Title Case)

Get HIV prevalence data entered from household surveys

Description

Get HIV prevalence data from household surveys that have been entered into Spectrum for validation of its HIV prevalence estimates.

Usage

dp.inputs.survey.hiv.prevalence(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.

Value

A data frame.

Details

Spectrum can store data from up to five household surveys. Data consist of HIV prevalence estimates by sex (male, female, both) and five-year age group (0-4, 5-9, ..., 75-79, 80+). Five statistics are stored for each group:

1. Number - not used

2. Prevalence - HIV prevalence point estimate

3. Lower - 95% confidence interval lower bound

4. Upper - 95% confidence interval upper bound

5. N - sample size. Countries may enter non-integral survey-weighted sample sizes

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