control_shamp: Epidemic Model Control Settings

In dth2/EpiModelHIV_SHAMP: Epidemic Modeling of HIV Transmission among MSM, MSMF and Heterosexual Populations

Description

Sets the controls for stochastic network models simulated with netsim.

Usage

control_shamp(simno = 1, nsims = 1, ncores = 1, nsteps = 100,
  start = 1, initialize.FUN = initialize_shamp, aging.FUN = aging,
  deaths.FUN = deaths_shamp, births.FUN = births_shamp2,
  demogupdate.FUN = demogupdate_shamp, test.FUN = test_shamp,
  tx.FUN = tx_shamp, prep.FUN = prep_shamp, progress.FUN = progress_msm,
  vl.FUN = vl_shamp, resim_nets.FUN = simnet_shamp,
  disclose.FUN = disclose_shamp, acts.FUN = acts_shamp,
  condoms.FUN = condoms_shamp, riskhist.FUN = riskhist_shamp,
  position.FUN = position_shamp, trans.FUN = trans_shamp,
  heatbath.FUN = heatbath_msmf_shamp, immigration.FUN = immigration_shamp,
  prev.FUN = prevalence_shamp, verbose.FUN = verbose_msm,
  save.nwstats = FALSE, verbose = TRUE, verbose.int = 1, ...)

Arguments

simno	Unique ID for the simulation run, used for file naming purposes if used in conjunction with the EpiModelHPC package.
nsims	Number of simulations.
ncores	Number of cores per run, if parallelization is used within the EpiModelHPC package.
nsteps	Number of time steps per simulation.
start	Starting time step for simulation, with default to 1 to run new simulation. This may also be set to 1 greater than the final time step of a previous simulation to resume the simulation with different parameters.
initialize.FUN	Module function to use for initialization of the epidemic model.
aging.FUN	Module function for aging.
deaths.FUN	Module function for general and disease-realted deaths.
births.FUN	Module function for births or entries into the population.
test.FUN	Module function for diagnostic disease testing.
tx.FUN	Module function for ART initiation and adherence.
prep.FUN	Module function for PrEP initiation and utilization.
progress.FUN	Module function for HIV disease progression.
vl.FUN	Module function for HIV viral load evolution.
resim_nets.FUN	Module function for network resimulation at each time step.
disclose.FUN	Module function for HIV status disclosure.
acts.FUN	Module function to simulate the number of sexual acts within partnerships.
condoms.FUN	Module function to simulate condom use within acts.
riskhist.FUN	Module function to calculate risk history for uninfected persons in the population.
position.FUN	Module function to simulate sexual position within acts.
trans.FUN	Module function to stochastically simulate disease transmission over acts given individual and dyadic attributes.
heatbath.FUN	Module function to stochastically simulate disease aquisition by msmf via contact with an unsimulated msm population. over acts given individual and dyadic attributes.
immigration.FUN	Module function to stochastically simulate disease aquisition by migrants via conatct with unsimulated populations in home counties during return trips.
prev.FUN	Module function to calculate prevalence summary statistics.
verbose.FUN	Module function to print model progress to the console or external text files.
save.nwstats	Calculate and save network statistics as defined in the simnet modules.
verbose	If TRUE, print out simulation progress to the console if in interactive mode or text files if in batch mode.
verbose.int	Integer specifying the interval between time steps at which progress is printed.
...	Additional arguments passed to the function.
aiclass.FUN	Module function for one-off AI risk class transitions.
roleclass.FUN	Module function for transitions in sexual roles.

Value

A list object of class control_shamp, which can be passed to the EpiModel function netsim.

dth2/EpiModelHIV_SHAMP documentation built on May 15, 2019, 4:56 p.m.