.check_statistic_args

The function treats these two arguments as related and checks
them in one place to remove repeated checks in several places in the
package.

internal

Provides methods to simulate and analyse the size and length
of branching processes with an arbitrary offspring distribution. These
can be used, for example, to analyse the distribution of chain sizes
or length of infectious disease outbreaks, as discussed in Farrington
et al. (2003) <doi:10.1093/biostatistics/4.2.279>.

James M. Azam

epichains

Simulating and Analysing Transmission Chain Statistics Using
Branching Process Models

Sebastian Funk

Flavio Finger

Zhian N. Kamvar

Hugo Gruson

Karim Mané

Pratik Gupte

Joshua W. Lambert

.check_statistic_args function

<dl><dt>statistic</dt>
<dd>The chain statistic to track as the
stopping criteria for each chain being simulated when <code>stat_threshold</code> is not
<code>Inf</code>; A <code>&lt;string&gt;</code>. It can be one of:<ul>
<li>"size": the total number of cases produced by a chain before it goes
extinct.</li>
<li>"length": the total number of generations reached by a chain before
it goes extinct.</li>
</ul></dd>
<dt>stat_threshold</dt>
<dd>A stopping criterion for individual chain simulations;
a positive number coercible to integer. When any chain's cumulative statistic
reaches or surpasses <code>stat_threshold</code>, that chain ends. Defaults to <code>Inf</code>.
For example, if <code>statistic = "size"</code> and <code>stat_threshold = 10</code>, then any
chain that produces 10 or more cases will stop. Note that setting
<code>stat_threshold</code> does not guarantee that all chains will stop at the same
value.</dd></dl>

Arguments

Check that the statistic and stat_threshold arguments are valid — .check_statistic_args

<dl>

<dt>statistic</dt>
<dd>The chain statistic to track as the
stopping criteria for each chain being simulated when <code>stat_threshold</code> is not
<code>Inf</code>; A <code>&lt;string&gt;</code>. It can be one of:<ul>
<li>"size": the total number of cases produced by a chain before it goes
extinct.</li>
<li>"length": the total number of generations reached by a chain before
it goes extinct.</li>
</ul></dd>


<dt>stat_threshold</dt>
<dd>A stopping criterion for individual chain simulations;
a positive number coercible to integer. When any chain's cumulative statistic
reaches or surpasses <code>stat_threshold</code>, that chain ends. Defaults to <code>Inf</code>.
For example, if <code>statistic = "size"</code> and <code>stat_threshold = 10</code>, then any
chain that produces 10 or more cases will stop. Note that setting
<code>stat_threshold</code> does not guarantee that all chains will stop at the same
value.</dd>

</dl>

Check that the <code>statistic</code> and <code>stat_threshold</code> arguments are valid

.check_statistic_args: Check that the `statistic` and `stat_threshold` arguments are valid

Description

Usage

Value

Arguments