.check_sim_args {epichains} | R Documentation |
Check inputs to simulate_chains()
and simulate_summary()
Description
Check inputs to simulate_chains()
and simulate_summary()
Usage
.check_sim_args(
n_chains,
statistic,
offspring_dist,
stat_threshold,
pop,
percent_immune
)
Arguments
n_chains |
Number of chains to simulate. |
statistic |
The chain statistic to track as the
stopping criteria for each chain being simulated when
|
offspring_dist |
Offspring distribution: a |
stat_threshold |
A stopping criterion for individual chain simulations;
a positive number coercible to integer. When any chain's cumulative statistic
reaches or surpasses |
pop |
Population size; An |
percent_immune |
Percent of the population immune to
infection at the start of the simulation; A |
Value
NULL; called for side effects