get_point_ids.tempnetwork: Given a vector of point-names (or a vector of point-ids) this...

Description Usage Arguments Value

View source: R/tempnetwork-tempflow-getter.R

Description

Given a vector of point-names (or a vector of point-ids) this function returns a vector containing the corresponding point-ids as defined in (the 'igraph'-object underlying) the 'tempflow'-object provided through the given 'tempnetwork'-object. If one of the given point-names (or point-ids) is not present and if 'safe' has the value TRUE, an error will be thrown.

Usage

1
2
3
## S3 method for class 'tempnetwork'
get_point_ids(tempNetwork,
  inpPointList = tP(tempNetwork), safe = TRUE)

Arguments

tempNetwork

A 'tempnetwork'-object.

inpPointList

Either a vector of strings representing point-names or a vector of integers representing a point-ids.

safe

If TRUE, it will be tested, whether the given point-names (or point-ids) are present in the 'tempflow'-object.

Value

The point-ids of the points specified in "inpPointList", as currently defined in the 'tempflow'-object provided through the given 'tempnetwork'-object.


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