control_msm: Epidemic Model Control Settings

In statnet/EpiModelHIV: Network-Based Epidemic Modeling of HIV Transmission among MSM and Heterosexual Populations

Description

Sets the controls for stochastic network models simulated with netsim.

Usage

control_msm(simno = 1, nsims = 1, ncores = 1, nsteps = 100,
  start = 1, initialize.FUN = initialize_msm, aging.FUN = aging_msm,
  departure.FUN = departure_msm, arrival.FUN = arrival_msm,
  hivtest.FUN = hivtest_msm, hivtx.FUN = hivtx_msm,
  hivprogress.FUN = hivprogress_msm, hivvl.FUN = hivvl_msm,
  resim_nets.FUN = simnet_msm, acts.FUN = acts_msm,
  condoms.FUN = condoms_msm, position.FUN = position_msm,
  prep.FUN = prep_msm, hivtrans.FUN = hivtrans_msm,
  stitrans.FUN = stitrans_msm, stirecov.FUN = stirecov_msm,
  stitx.FUN = stitx_msm, prev.FUN = prevalence_msm,
  verbose.FUN = verbose.net, save.nwstats = FALSE,
  save.clin.hist = FALSE, truncate.plist = TRUE, verbose = TRUE, ...)

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.
departure.FUN	Module function for general and disease-realted depatures.
arrival.FUN	Module function for entries into the sexually active population.
hivtest.FUN	Module function for HIV diagnostic disease testing.
hivtx.FUN	Module function for ART initiation and adherence.
hivprogress.FUN	Module function for HIV disease progression.
hivvl.FUN	Module function for HIV viral load evolution.
resim_nets.FUN	Module function for network resimulation at each time step.
acts.FUN	Module function to simulate the number of sexual acts within partnerships.
condoms.FUN	Module function to simulate condom use within acts.
position.FUN	Module function to simulate sexual position within acts.
prep.FUN	Module function for PrEP initiation and utilization.
hivtrans.FUN	Module function to stochastically simulate HIV transmission over acts given individual and dyadic attributes.
stitrans.FUN	Module function to simulate GC/CT transmission over current edgelist.
stirecov.FUN	Module function to simulate recovery from GC/CT, heterogeneous by disease, site, symptoms, and treatment status.
stitx.FUN	Module function to simulate treatment of GC/CT.
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.
save.clin.hist	Save individual-level clinical history matrices.
truncate.plist	Truncate the cumulative partnership list to only include active partnerships.
verbose	If TRUE, print out simulation progress to the console if in interactive mode or text files if in batch mode.
...	Additional arguments passed to the function.

Value

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

statnet/EpiModelHIV documentation built on Aug. 28, 2020, 11:07 p.m.