EpiModel (version 0.95)

get.stat: Get Active Status from NetworkDynamic Object

Description

This function outputs information on the disease or outcome status stored in the networkDyamic status TEA used by epiNet.simTrans.

Usage

get.stat(all, stat = 1, at, out, mode, require.active = TRUE)

Arguments

all

a list object containing a networkDynamic object and other initialization information passed from epiNet.simTrans.

stat

a vector of status values in numeric to query (the standard status representation is 0 = negative, 1 = infected, 2 = recovered).

at

time step to query.

out

function output, with options of out="vec" for a vector of status, out="ids" for a vector of IDs with status equal to stat, and out="prev" for the number current with status equal to stat

mode

if nw is bipartite, the mode number for status (may be ignored if requesting output for both modes).

require.active

if TRUE, NA will be returned instead of an attribute value if the associated vertex or edge is inactive for the query period (see get.vertex.attribute.active).

Details

This network utility is used during the epiNet.simTrans simulation process to query the ID numbers and size of currently active nodes with a specific disease status. A more efficient query just for state sizes of status = 1 is found in get.prev.

See Also

get.prev