rgborel

Generate random numbers from a Gamma-Borel mixture distribution

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

rgborel function

<dl><dt>n</dt>
<dd>Number of random variates to generate.</dd>
<dt>size</dt>
<dd>The dispersion parameter (often called <code>k</code> in ecological
applications); A positive number.</dd>
<dt>prob</dt>
<dd>Probability of success (in the parameterisation with
<code>prob</code>, see also <code><a href="/link/NegBinomial?package=epichains&version=0.1.1" data-mini-rdoc="epichains::NegBinomial">NegBinomial</a></code>); A number between
0 and 1.</dd>
<dt>mu</dt>
<dd>Mean; A positive number.</dd>
<dt>censor_at</dt>
<dd>A stopping criterion; <code>&lt;numeric&gt;</code>. Defaults to <code>Inf</code>. A
value above which the simulation ends and the random number is set to
<code>Inf</code> (as a form of censoring). <code>rborel()</code> simulates chain sizes using
<code>simulate_chain_stats()</code> with a Poisson offspring distribution, so if
<code>mu &gt;= 1</code>, the simulation could proceed unendingly. This parameter is used
to prevent this.</dd></dl>

Arguments

Author

Generate random numbers from a Gamma-Borel mixture distribution — rgborel

<dl>

<dt>n</dt>
<dd>Number of random variates to generate.</dd>


<dt>size</dt>
<dd>The dispersion parameter (often called <code>k</code> in ecological
applications); A positive number.</dd>


<dt>prob</dt>
<dd>Probability of success (in the parameterisation with
<code>prob</code>, see also <code><a href='https://rdrr.io/r/stats/NegBinomial.html'>NegBinomial</a></code>); A number between
0 and 1.</dd>


<dt>mu</dt>
<dd>Mean; A positive number.</dd>


<dt>censor_at</dt>
<dd>A stopping criterion; <code>&lt;numeric&gt;</code>. Defaults to <code>Inf</code>. A
value above which the simulation ends and the random number is set to
<code>Inf</code> (as a form of censoring). <code>rborel()</code> simulates chain sizes using
<code>simulate_chain_stats()</code> with a Poisson offspring distribution, so if
<code>mu &gt;= 1</code>, the simulation could proceed unendingly. This parameter is used
to prevent this.</dd>

</dl>

Generate random numbers from a Gamma-Borel mixture distribution

rgborel: Generate random numbers from a Gamma-Borel mixture distribution

Description

Usage

Value

Arguments

Author

Examples