Skip to contents

Get the Cumulative Edgelists of a Model

Source: R/edgelists.R
get_cumulative_edgelists_df.Rd

Combines the cumulative edgelists from one or more network layers into a single data.frame, adding a network column to identify the layer. Like get_cumulative_edgelist(), this requires control.net(cumulative.edgelist = TRUE).

Usage

get_cumulative_edgelists_df(dat, networks = NULL)

Arguments

dat

Main netsim_dat object containing a networkDynamic object and other initialization information passed from netsim().

networks

Numerical indexes of the networks to extract the partnerships from. (May be > 1 for models with multiple overlapping networks.) If NULL, extract from all networks.

Value

A data.frame with 5 columns:

  • head: the unique ID (see get_unique_ids()) of the head node.

  • tail: the unique ID of the tail node.

  • start: the time step at which the edge formed.

  • stop: the time step at which the edge dissolved, or NA if still active.

  • network: the numerical index of the network on which the partnership lives.

Note: column names head/tail here match the single-network get_cumulative_edgelist() output. The index/partner naming used by get_partners() is reserved for queries about specific index nodes.

See also

get_cumulative_edgelist() (single network), control.net() (cumulative.edgelist, save.cumulative.edgelist). vignette("network-objects", package = "EpiModel") walks through the full lifecycle.

Other cumulative_edgelist: as_cumulative_edgelist(), dedup_cumulative_edgelist(), get_cumulative_degree(), get_cumulative_edgelist(), get_partners(), reachable-nodes, update_cumulative_edgelist()