get_cumulative_degree: Return the Cumulative Degree of a Set of Index Nodes

In EpiModel: Mathematical Modeling of Infectious Disease Dynamics

Return the Cumulative Degree of a Set of Index Nodes

Description

Counts the number of distinct partners each of a set of index nodes has accumulated over the tracked history. A thin wrapper around get_partners() that collapses the partner list to a count per index.

Usage

get_cumulative_degree(
  dat,
  index_posit_ids,
  networks = NULL,
  truncate = Inf,
  only.active.nodes = FALSE
)

Arguments

dat	Main netsim_dat object containing a networkDynamic object and other initialization information passed from netsim().
index_posit_ids	The positional IDs of the indexes of interest.
networks	Numerical indexes of the networks to extract the partnerships from. (May be > 1 for models with multi-layer networks.) If NULL, extract from all networks.
truncate	After how many time steps a partnership that is no longer active should be removed from the output. See the Truncation section.
only.active.nodes	If TRUE, then inactive (e.g., deceased) partners will be removed from the output.

Value

A data.frame with 2 columns:

• index_pid: the positional ID (see get_posit_ids()) of the indexes.

• degree: the cumulative degree of the index.

Cumulative Degree

The cumulative degree of a node is the number of distinct partners connected to it during the tracked time window. The window is whatever history the cumulative edgelist currently contains (controlled at simulation time by control$truncate.el.cuml and at call time by the truncate argument).

See Also

get_partners() for the full partner list backing this count.

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

Examples

## Not run: 
get_cumulative_degree(dat, index_posit_ids = 1:50, truncate = 52)

## End(Not run)

EpiModel documentation built on Oct. 16, 2026, 5:07 p.m.