get_step_ids.tempnetwork: This function returns the edge-ids (as currently defined in...

In KonstantinRK/tempnetwork:

Description

This function returns the edge-ids (as currently defined in the 'igraph'-object underlying the 'tempflow'-object of the given 'tempnetwork'-object), of the edges which are characterised by their start- and endpoints that are specified by the input vectors srcPointList and dstPointList respectively, both of which are containing point-names (or point-ids).

Usage

## S3 method for class 'tempnetwork'
get_step_ids(tempNetwork, srcPointList = NULL,
  dstPointList = NULL, safe = TRUE)

Arguments

tempNetwork	A 'tempnetwork'-object.
srcPointList	The vector containing the point-names (or point-ids) representing the start-points of the desired edges.
dstPointList	The vector containing the point-names (or point-ids) representing the end-points of the desired edges.
safe	If TRUE, it will be tested, whether the specified point-names (or point-ids) are present in the 'tempflow'-object of the given 'tempnetwork'-object; whether the vectors have the same length; whether the specified edges are present in the 'tempflow'-object of the given 'tempnetwork'-object.

Value

A vector of the current step-ids, as defined in the 'igraph'-object underlying the 'tempflow'-object of the given 'tempnetwork'-object.

KonstantinRK/tempnetwork documentation built on Dec. 23, 2019, 6:40 p.m.