set.global.transmission.rate: Sets the global HIV transmission rate

View source: R/transmission.R

set.global.transmission.rateR Documentation

Sets the global HIV transmission rate

Description

Sets the global HIV transmission rate

Usage

set.global.transmission.rate(
  jheem,
  transmission.rate,
  transmission.route.names = jheem$transmission.routes,
  time = -Inf
)

Arguments

jheem

An initialized JHEEM object

transmission.rate

a single numeric value representing the global transmission rate, which can be used to tune the epidemic across all strata

transmission.route.names

The names of the transmission routes to which the transmissibility should apply (a subset of the 'transmission.route.names' given to initialize.jheem)

time

The time at which this transmission rate applies, if time-varying

Details

The transmission rate (for one route of transmission) from stratum a (hiv-positive) to stratum b (hiv-negative) is a product of five components (four of which are set as parameters, and one of which - HIV prevalence - is determined by running the model):

  • A global transmission rate - applies to all strata equally (set.global.transmission.rate)

  • Transmissibility - all factors which depend only on the characteristics of the HIV-positive stratum a (set.transmissibility)

  • Contact rate - all factors which depend on both the general characteristics of the HIV-positive stratum a (ie age, race, subpopulation, sex, risk factor) and the characteristics of the HIV-negative stratum b (set.transmission.contact.array)

  • Susceptibility - all factors which depend only on the characteristics of the HIV-negative stratum b (set.susceptibility)

  • Prevalence of HIV within the general characteristics of the HIV-positive stratum a (ie age, race, subpopulation, sex, risk factor). This is not set, but is estiated at model run time

See Also

Other functions to specify transmission: set.new.infection.proportions(), set.susceptibility(), set.transmissibility(), set.transmission.contact.array()


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