init.icm {EpiModel}R Documentation

Initial Conditions for Stochastic Individual Contact Models

Description

Sets the initial conditions for stochastic individual contact models simulated with icm.

Usage

init.icm(s.num, i.num, r.num, s.num.g2, i.num.g2, r.num.g2, ...)

Arguments

s.num

Number of initial susceptible persons. For two-group models, this is the number of initial group 1 susceptible persons.

i.num

Number of initial infected persons. For two-group models, this is the number of initial group 1 infected persons.

r.num

Number of initial recovered persons. For two-group models, this is the number of initial group 1 recovered persons. This parameter is only used for the SIR model type.

s.num.g2

Number of initial susceptible persons in group 2. This parameter is only used for two-group models.

i.num.g2

Number of initial infected persons in group 2. This parameter is only used for two-group models.

r.num.g2

Number of initial recovered persons in group 2. This parameter is only used for two-group SIR models.

...

Additional initial conditions passed to model.

Details

The initial conditions for a model solved with icm should be input into the init.icm function. This function handles initial conditions for both base models and original models using new modules. For an overview of initial conditions for base ICM class models, consult the Basic ICMs tutorial.

Value

An EpiModel object of class init.icm.

See Also

Use param.icm to specify model parameters and control.icm to specify the control settings. Run the parameterized model with icm.


[Package EpiModel version 2.4.0 Index]