get_step_ids.tempflow: This function returns the edge-ids, as currently defined in...

Description Usage Arguments Value

View source: R/tempflow-getter.R

Description

This function returns the edge-ids, as currently defined in (the 'igraph'-object underlying) the given 'tempflow'-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

1
2
3
## S3 method for class 'tempflow'
get_step_ids(tempFlow, srcPointList = NULL,
  dstPointList = NULL, safe = TRUE)

Arguments

tempFlow

A 'tempflow'-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 given 'tempflow'-object; whether the vectors have the same length; whether the specified edges are present in the given 'tempflow'-object.

Value

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


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