.epichains_summary {epichains} | R Documentation |
Create an <epichains_summary>
object
Description
epichains_summary()
constructs an <epichains_summary>
object.
An <epichains_summary>
object is a <vector>
of the simulated
chain sizes or lengths. It also stores information on the number of chains
simulated, and the statistic that was tracked.
Usage
.epichains_summary(
chains_summary,
n_chains,
offspring_dist,
statistic = c("size", "length"),
stat_threshold = Inf
)
Arguments
chains_summary |
A numeric |
n_chains |
Number of chains to simulate. |
offspring_dist |
Offspring distribution: a |
statistic |
The chain statistic to track as the
stopping criteria for each chain being simulated when
|
stat_threshold |
A stopping criterion for individual chain simulations;
a positive number coercible to integer. When any chain's cumulative statistic
reaches or surpasses |
Value
An <epichains_summary>
object.
Author(s)
James M. Azam