.get_susceptible_offspring

Sample susceptible offspring to be infected from all possible offspring.
This function is used internally, and input checking is not
performed here, only in the context where it is used. Using it directly
is not recommended.

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

.get_susceptible_offspring function

<dl><dt>new_offspring</dt>
<dd>A numeric vector of the possible new offspring per
chain produced by <code>.sample_possible_offspring()</code>.</dd>
<dt>pop</dt>
<dd>Population size; An <code>&lt;Integer&gt;</code>. Used alongside <code>percent_immune</code>
to define the susceptible population. Defaults to <code>Inf</code>.</dd></dl>

Arguments

Sample the number of susceptible offspring from all possible offspring — .get_susceptible_offspring

<dl>

<dt>new_offspring</dt>
<dd>A numeric vector of the possible new offspring per
chain produced by <code>.sample_possible_offspring()</code>.</dd>


<dt>pop</dt>
<dd>Population size; An <code>&lt;Integer&gt;</code>. Used alongside <code>percent_immune</code>
to define the susceptible population. Defaults to <code>Inf</code>.</dd>

</dl>

Sample the number of susceptible offspring from all possible offspring

.get_susceptible_offspring: Sample the number of susceptible offspring from all possible offspring

Description

Usage

Value

Arguments