extract.hiv.specific.mortality: Extract HIV-specific mortality from JHEEM Results

In tfojo1/jheem: Executes the JHEEM (Johns Hopkins Epidemiological and Economic Model) - a compartmental model of HIV

Extract HIV-specific mortality from JHEEM Results

Description

Extract HIV-specific mortality from JHEEM Results

Usage

extract.hiv.specific.mortality(
  results,
  years = NULL,
  ages = NULL,
  races = NULL,
  subpopulations = NULL,
  sexes = NULL,
  risks = NULL,
  continuum = NULL,
  cd4s = NULL,
  hiv.subsets = NULL,
  keep.dimensions = NULL,
  include.hiv.negative.in.denominator = T,
  per.population = 1e+05,
  transformation.fn = NULL,
  use.cdc.categorizations = F
)

Arguments

results	The results of a call to run.jheem
years	The elements of each of the possible result dimensions for which to extract results. If passed null, defaults to all elements of each dimension
ages	The elements of each of the possible result dimensions for which to extract results. If passed null, defaults to all elements of each dimension
races	The elements of each of the possible result dimensions for which to extract results. If passed null, defaults to all elements of each dimension
subpopulations	The elements of each of the possible result dimensions for which to extract results. If passed null, defaults to all elements of each dimension
risks	The elements of each of the possible result dimensions for which to extract results. If passed null, defaults to all elements of each dimension
continuum	The elements of each of the possible result dimensions for which to extract results. If passed null, defaults to all elements of each dimension
cd4s	The elements of each of the possible result dimensions for which to extract results. If passed null, defaults to all elements of each dimension
keep.dimensions	The names of which dimensions to marginalize over (all other dimensions will be summed out) - a subset of 'year', 'age', 'race', 'subpopulation', 'sex', 'risk', 'non.hiv.subset', 'continuum', 'cd4', and 'hiv.subset'. If passed null, defaults to keep the year dimension, and any other dimension for which more than one but less than all elements of that dimension are selected
include.hiv.negative.in.denominator	Whether to include HIV negative individuals in the denominator (only applies if per.population is set)
per.population	The unit of the denominator if the return value should be a proportion of the population. If NA, the absolute number is returned without dividing by the population size

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