incidence.calculator: Calculate HIV incidence, overall and stratified.

Description Usage Arguments Value Examples

View source: R/Misc/Pre.hhohhoMaxARTFinal.Sim/hho.rsimpacthelper.R View source: R/incidence.calculator.R

Description

Produces a data frame that contains the overall, and gender-stratified, HIV incidence at a specified time window and for a specific age group.

Usage

1
2
incidence.calculator(datalist = datalist, agegroup = c(15, 30),
  timewindow = c(20, 30), only.active = "No")

Arguments

datalist

The list object that is produced by readthedata

agegroup

Boundaries of the age group (lower bound <= age < upper bound) that should be retained. Should be expressed as a vector of two integers. e.g. c(15, 30)

timewindow

Boundaries of the time window (lower bound < time <= upper bound) that should be retained. Should be expressed as a vector of two integers. e.g. c(20, 30)

only.active

Should only women who are in sexual relationships contribute exposure time? If "Strict", all time spent being single will be excluded from exposure time. If "Harling", time will be excluded from exposure time in blocks of one year, if the person spent that entire block not in any relationship. If "No", exposure time is being contributed, even while not in any relationships. WARNING: The "Harling" and "Strict" estimates currently only work for women. So the resulting data frame will still contain incidence estimates for men as if you selected "No".

Value

A dataframe with cases, exposure times, incidence estimates and surrounding confidence bounds, for the specified time window and age group, overall, and stratified by gender.

Examples

1
2
3
4
5
cfg <- list()
modeloutput <- RSimpactCyan::simpact.run(configParams = cfg, destDir = "temp")
dl <- readthedata(modeloutput)
incidence.df <- incidence.calculator(datalist = datalist, agegroup = c(15, 30), timewindow = c(20, 30))
incidence.df

wdelva/RSimpactHelp documentation built on Dec. 26, 2019, 3:42 a.m.