get.timing.info: Retrieve the timing information present in a networkDynamic.

In networkDynamic: Dynamic Extensions for Network Objects

Retrieve the timing information present in a networkDynamic.

Description

These methods return either the activity spells of each vertex or edge or the unique time points at which edges and vertices become active or inactive.

Finds all of the unique time points at which the edges and/or vertices become active or inactive.

Usage

get.change.times(x, vertex.activity=TRUE, edge.activity=TRUE, ignore.inf=TRUE,
             vertex.attribute.activity = TRUE, edge.attribute.activity = TRUE,
             network.attribute.activity = TRUE)
get.vertex.activity(x, v=seq_len(network.size(x)), 
                   as.spellList=FALSE, active.default=TRUE)
get.edge.activity(x, e=seq_along(x$mel), as.spellList=FALSE, active.default=TRUE)

Arguments

x	an object, of class network or networkDynamic.
vertex.activity	logical, whether the times at which vertices become active or inactive is to be returned.
edge.activity	logical, whether the times at which edges become active or inactive is to be returned.
vertex.attribute.activity	logical, whether the times attached to any dynamic vertex attributes should be returned
edge.attribute.activity	logical, whether the times attached to any dynamic edge attributes should be returned
network.attribute.activity	logical, whether the times attached to any dynamic network attributes should be returned
ignore.inf	logical, whether Inf value will be ignored or not.
e	IDs for the edges whose activity spells are wanted.
v	IDs for the vertices whose activity spells are wanted.
as.spellList	should data be returned in spell matrix form? TODO: should this be callsed as.spellmatrix instead?
active.default	logical, should edges / vertices with no spell activity defined be treated as always active (TRUE) and included in output, or never active (FALSE) and skipped.

Value

For the get.change.times function, the default settings return a vector of all of the finite time points at which any edge or any vertex becomes active or inactive, or any of their dynamic attributes change. If only one of the logical arguments, say vertex.activity, is set to FALSE, then the time points for the corresponding parts of the data structure will not be returned. If both are FALSE, numeric(0) is returned.

For the get.vertex.activity and get.edge.activity functions, a list of activity spells is returned with each list element corresponding to the id of the vertex or edge. Deleted edges will appear as NULL entries, as will any spell marked as inactive with the 'null' (Inf,Inf) spell. If the argument as.spellList=TRUE the activity spells are instead formatted as a data.frame and include additional columns to indicate possible onset- and terminus-censoring. Any 'null' spells and deleted edges will be omited.

For get.vertex.activity the columns are [onset,terminus,vertex.id,onset.censored,terminus.censored,duration].

For get.edge.activity the columns are [onset, terminus, tail, head, onset.censored, terminus.censored, duration, edge.id] .

The data.frames will be sorted by id, onset, terminus.

If a net.obs.period network attribute is set, the range of its $observations element is substituted in for the -Inf and Inf values that otherwise indicate the onset- and terminus-censored observations.

Author(s)

Ayn Leslie-Cook [e-mail], Carter T. Butts [e-mail],skyebend

See Also

See also activity.attribute,net.obs.period,as.data.frame.networkDynamic

Examples

  library(networkDynamic)
  data(flo)
  net1 <- network(flo)
  activate.edges(net1, onset=1:20, terminus=101:120)
  activate.vertices(net1, at=seq(2,32,2))
  get.change.times(net1)
  get.edge.activity(net1)
  get.edge.activity(net1,as.spellList=TRUE)
  get.vertex.activity(net1)
  
  a <-network.initialize(5)
  activate.vertices(a,onset=0,terminus=Inf)
  get.change.times(a,ignore.inf=FALSE)

networkDynamic documentation built on May 29, 2024, 1:16 a.m.