networkDynamic: get.dyads.active – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

get.dyads.active

Return the set of vertex ids of edges active at a given time

Description

Constructs a matrix, essentially an edgelist, of the pairs of vertices connected by edges active within the query spell.

Usage

get.dyads.active(nD, onset = NULL, terminus = NULL, length = NULL, at = NULL, 
                rule = c("any", "all", "earliest", "latest"), active.default = TRUE)

Arguments

`nD`	networkDynamic object to be queried
`onset`	optional numeric value giving onset time of query spell
`terminus`	optional numeric value giving terminus time of query spell
`length`	optional numeric value giving length (duration) of query spell
`at`	optional numeric value giving single time point to query
`rule`	a character string indicating the definition of "active" for this query: `any` (default) to define active as any active spell during the interval, or `all` to define active as being active over the entire interval. For this functions, the values of `earliest` and `latest` are equivalent to `any` and are only included for consistency.
`active.default`	logical; should elements without an activity attribute be regarded as active by default? Default to `TRUE`

Details

Uses is.active internally. The ordering of matrix rows is arbitrary. The ordering of vertices in non-directed networks corresponds to how they were set in the data structure (i.e. does not enforce i > j) If no edges are active or exist, a matrix with zero rows will be returned.

Value

Returns a two-column numeric matrix in which the first column gives a tail vertex.id and the second column gives the head vertex.id and each row corresponds to the existence of an active relationship between the vertices for the given query spell.

Note

This function does not support hypergraphic networks.

Author(s)

skyebend

Examples

data(windsurfers)
 get.dyads.active(windsurfers,onset=2,terminus=3)

networkDynamic

Dynamic Extensions for Network Objects

v0.10.1

GPL-3

Authors

Carter T. Butts [aut], Ayn Leslie-Cook [aut], Pavel N. Krivitsky [aut], Skye Bender-deMoll [aut, cre], Zack Almquist [ctb], David R. Hunter [ctb], Li Wang [ctb], Kirk Li [ctb], Steven M. Goodreau [ctb], Jeffrey Horner [ctb], Martina Morris [ctb]

Initial release

2020-01-16