update_cumulative_edgelist

Update a Cumulative Edgelist of the Specified Network

Tools for simulating mathematical models of infectious disease dynamics.
Epidemic model classes include deterministic compartmental models, stochastic
individual-contact models, and stochastic network models. Network models use the
robust statistical methods of exponential-family random graph models (ERGMs)
from the Statnet suite of software packages in R. Standard templates for epidemic
modeling include SI, SIR, and SIS disease types. EpiModel features an API for
extending these templates to address novel scientific research aims. Full
methods for EpiModel are detailed in Jenness et al. (2018, <doi:10.18637/jss.v084.i08>).

Samuel Jenness

EpiModel

Mathematical Modeling of Infectious Disease Dynamics

Steven M. Goodreau

Martina Morris

Adrien Le Guillou

Chad Klumb

Skye Bender-deMoll

update_cumulative_edgelist function

<dl><dt>dat</dt>
<dd>Main <code>netsim_dat</code> object containing a <code>networkDynamic</code>
object and other initialization information passed from
<code>netsim</code>.</dd>
<dt>network</dt>
<dd>Numerical index of the network for which the cumulative
edgelist will be updated. (May be &gt; 1 for models with
multiple overlapping networks.)</dd>
<dt>truncate</dt>
<dd>After how many time steps a partnership that is no longer
active should be removed from the output.</dd></dl>

Arguments

To avoid storing a cumulative edgelist too long, the <code>truncate</code>
parameter defines a number of steps after which an edge that is no longer
active is truncated out of the cumulative edgelist.
When <code>truncate = Inf</code>, no edges are ever removed. When
<code>truncate = 0</code>, only the active edges are kept. You may want this
behavior to keep track of the active edges' start step.

Truncation

Update a Cumulative Edgelist of the Specified Network — update_cumulative_edgelist

<dl>

<dt>dat</dt>
<dd>Main <code>netsim_dat</code> object containing a <code>networkDynamic</code>
object and other initialization information passed from
<code>netsim</code>.</dd>


<dt>network</dt>
<dd>Numerical index of the network for which the cumulative
edgelist will be updated. (May be &gt; 1 for models with
multiple overlapping networks.)</dd>


<dt>truncate</dt>
<dd>After how many time steps a partnership that is no longer
active should be removed from the output.</dd>

</dl>

To avoid storing a cumulative edgelist too long, the <code>truncate</code>
parameter defines a number of steps after which an edge that is no longer
active is truncated out of the cumulative edgelist.
When <code>truncate = Inf</code>, no edges are ever removed. When
<code>truncate = 0</code>, only the active edges are kept. You may want this
behavior to keep track of the active edges' start step.

update_cumulative_edgelist: Update a Cumulative Edgelist of the Specified Network

Description

Usage

Value

Arguments

Truncation