set.track.mortality: Set whether the JHEEM should track HIV-specific and overall...

View source: R/tracking.R View source: R/population_growth.R

set.track.mortalityR Documentation

Set whether the JHEEM should track HIV-specific and overall mortality

Description

A convenience function that bundles set.track.hiv.specific.mortality and set.track.overall.mortality into one function call

A convenience function that bundles set.track.hiv.specific.mortality and set.track.overall.mortality into one function call

Usage

set.track.mortality(
  jheem,
  track.hiv.specific.mortality = T,
  track.overall.hiv.positive.mortality = T,
  track.overall.hiv.negative.mortality = T,
  dimensions.hiv.specific.mortality = c("age", "race", "subpopulation", "sex", "risk",
    "continuum", "cd4", "hiv.subset"),
  dimensions.overall.hiv.positive.mortality = c("age", "race", "subpopulation", "sex",
    "risk", "continuum", "cd4", "hiv.subset"),
  dimensions.overall.hiv.negative.mortality = c("age", "race", "subpopulation", "sex",
    "risk", "non.hiv.subset")
)

set.track.mortality(
  jheem,
  track.hiv.specific.mortality = T,
  track.overall.hiv.positive.mortality = T,
  track.overall.hiv.negative.mortality = T,
  dimensions.hiv.specific.mortality = c("age", "race", "subpopulation", "sex", "risk",
    "continuum", "cd4", "hiv.subset"),
  dimensions.overall.hiv.positive.mortality = c("age", "race", "subpopulation", "sex",
    "risk", "continuum", "cd4", "hiv.subset"),
  dimensions.overall.hiv.negative.mortality = c("age", "race", "subpopulation", "sex",
    "risk", "non.hiv.subset")
)

Arguments

jheem

An object of jheem-class

track.hiv.specific.mortality, track.overall.hiv.positive.mortality, track.overall.hiv.negative.mortality

Booleans indicating whether or not to track each type for mortality

dimensions.hiv.specific.mortality, dimensions.overall.hiv.positive.mortality

The names of dimensions to keep when tracking hiv-positive mortality. Must be a subset of <'age','race','subpopulation','sex','risk','continuum','cd4','hiv.subset'>

dimensions.overall.hiv.negative.mortality

The names of dimensions to keep when tracking HIV-negative mortality. Must be a subset of <'age','race','subpopulation','sex','risk','non.hiv.subset'>

See Also

Other function to set up JHEEM mortality: set.track.hiv.specific.mortality(), set.track.overall.mortality()

Other function to set up JHEEM mortality: set.track.hiv.specific.mortality(), set.track.overall.mortality()


tfojo1/jheem documentation built on Oct. 7, 2022, 1:24 p.m.