get.population.skeleton: Get a skeleton for a population with indicated dimensions

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

Get a skeleton for a population with indicated dimensions

Description

Gets an array, with all values set to value, with dimensions and names corresponding to the shared elements of both HIV-positive and HIV-negative populations (age, race, subpopulation, sex*risk) for the specified JHEEM model

Usage

get.population.skeleton(
  jheem,
  value = 0,
  age = F,
  race = F,
  subpopulation = F,
  sex = F,
  risk = F,
  non.hiv.subset = F,
  continuum = F,
  cd4 = F,
  hiv.subset = F,
  age.from = F,
  race.from = F,
  subpopulation.from = F,
  sex.from = F,
  risk.from = F,
  non.hiv.subset.from = F,
  continuum.from = F,
  cd4.from = F,
  hiv.subset.from = F,
  age.to = F,
  race.to = F,
  subpopulation.to = F,
  sex.to = F,
  risk.to = F,
  non.hiv.subset.to = F,
  continuum.to = F,
  cd4.to = F,
  hiv.subset.to = F
)

Arguments

jheem	An object of jheem-class
value	The value to fill the array with. If value=='sequential', the array will be population with numbers 1:<size of the array>
age, race, subpopulation, sex, risk, non.hiv.subset, continuum, cd4, hiv.subset, age.from, race.from, subpopulation.from, sex.from, risk.from, non.hiv.subset.from, continuum.from, cd4.from, hiv.subset.from, age.to, race.to, subpopulation.to, sex.to, risk.to, non.hiv.subset.to, continuum.to, cd4.to, hiv.subset.to	Indicators for whether these strata should be incorporated into the returned skeleton

See Also

get.population.skeleton, get.hiv.negative.population.skeleton, get.hiv.positive.population.skeleton

Other functions to build population array skeletons: get.contact.array.skeleton(), get.general.population.skeleton(), get.hiv.negative.population.skeleton(), get.hiv.positive.population.skeleton()

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