.new_epichains {epichains} | R Documentation |
Construct an <epichains>
object
Description
new_epichains()
constructs an <epichains>
object from a
supplied <data.frame>
and extra attributes passed as individual arguments.
It is meant to be lazy and performant, by creating the object without
checking the arguments for correctness. It is not safe to call
new_epichains()
on its own as is called within epichains()
after the arguments have been checked. To create an <epichains>
object, use epichains()
.
Usage
.new_epichains(
sim_df,
n_chains,
statistic,
offspring_dist,
stat_threshold,
track_pop
)
Arguments
sim_df |
a |
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 |
track_pop |
Was the susceptible population tracked? Logical. |
Author(s)
James M. Azam