.new_epichains_summary {epichains} | R Documentation |
<epichains_summary>
objectnew_epichains_summary()
constructs an <epichains_summary>
object from a
supplied <vector>
of chain sizes or lengths. It also stores extra
attributes passed as individual arguments.
new_epichains_summary()
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_summary()
on its own as is called within
epichains_summary()
after the arguments have been checked. To create a
new <epichains_summary>
object safely, use epichains_summary()
.
.new_epichains_summary(
chains_summary,
n_chains,
statistic,
offspring_dist,
stat_threshold
)
chains_summary |
A numeric |
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 |
James M. Azam