get.contact.array.skeleton: Get a skeleton contact array

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

Get a skeleton contact array

Description

Gets an array, with all values set to value, with dimensions and names corresponding to the contact transmission array: [age from, race from, subpopulation from, sex from, risk from, age to, race to, subpopulation to, sex to, risk to, non-hiv subset to]

Usage

get.contact.array.skeleton(
  jheem,
  value = 0,
  age = F,
  race = F,
  subpopulation = F,
  sex = F,
  risk = F,
  non.hiv.subset = F,
  age.from = age,
  race.from = race,
  subpopulation.from = subpopulation,
  sex.from = sex,
  risk.from = risk,
  age.to = age.from,
  race.to = race.from,
  subpopulation.to = subpopulation.from,
  sex.to = sex.from,
  risk.to = risk.from,
  non.hiv.subset.to = non.hiv.subset,
  all.dimensions = !age.from && !race.from && !subpopulation.from && !sex.from &&
    !risk.from && !age.to && !race.to && !subpopulation.to && !sex.to && !risk.to &&
    !non.hiv.subset.to
)

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	Indicators for whether these strata should be incorporated into the returned skeleton
race	Indicators for whether these strata should be incorporated into the returned skeleton
subpopulation	Indicators for whether these strata should be incorporated into the returned skeleton
sex	Indicators for whether these strata should be incorporated into the returned skeleton
risk	Indicators for whether these strata should be incorporated into the returned skeleton
non.hiv.subset	Indicators for whether these strata should be incorporated into the returned skeleton
age.from	Indicators for whether these strata should be incorporated into the returned skeleton
race.from	Indicators for whether these strata should be incorporated into the returned skeleton
subpopulation.from	Indicators for whether these strata should be incorporated into the returned skeleton
sex.from	Indicators for whether these strata should be incorporated into the returned skeleton
risk.from	Indicators for whether these strata should be incorporated into the returned skeleton
age.to	Indicators for whether these strata should be incorporated into the returned skeleton
race.to	Indicators for whether these strata should be incorporated into the returned skeleton
subpopulation.to	Indicators for whether these strata should be incorporated into the returned skeleton
sex.to	Indicators for whether these strata should be incorporated into the returned skeleton
risk.to	Indicators for whether these strata should be incorporated into the returned skeleton
non.hiv.subset.to	Indicators for whether these strata should be incorporated into the returned skeleton
all.dimensions	If true, returns a contact array with all dimensions (age, race, subpopulation, sex, risk - both to and from) in it. If false, returns only the selected dimensions

See Also

set.transmission.contact.array

Other functions for transmission contact arrays: create.contact.array.from.marginals(), multiply.contact.array.from(), multiply.contact.array.to(), set.transmission.contact.array()

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

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