extract.population.subset: Extract a subset of the population from JHEEM Results

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

Extract a subset of the population from JHEEM Results

Description

Extract a subset of the population from JHEEM Results

Usage

extract.population.subset(
  results,
  years = NULL,
  ages = NULL,
  races = NULL,
  subpopulations = NULL,
  sexes = NULL,
  risks = NULL,
  non.hiv.subsets = NULL,
  continuum = NULL,
  cd4s = NULL,
  hiv.subsets = NULL,
  include.hiv.positive = T,
  include.hiv.negative = T,
  keep.dimensions = NULL,
  denominator.dimensions = "year",
  per.population = NA,
  transformation.fn = NULL,
  use.cdc.categorizations = F
)

Arguments

results	The results of a call to run.jheem
years, ages, races, subpopulations, risks, non.hiv.subsets, continuum, 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
include.hiv.positive, include.hiv.negative	Whether to include the hiv.positive and hiv.negative subpopulations (at least one of these two must be set to true)
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
denominator.dimensions	If the population should be normalized, which dimensions to use in the denominator (only applies if per.population is not NA). This must be a subset of the keep.dimensions. If NULL, the results are reported as fractions of the total population
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.