get_point_id.tempnetwork: Given a point-name (or a point-id) this function returns the...

Description Usage Arguments Value

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

Description

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

Usage

1
2
## S3 method for class 'tempnetwork'
get_point_id(tempNetwork, inpPoint, safe = TRUE)

Arguments

tempNetwork

A 'tempnetwork'-object.

inpPoint

Either a string representing the point-name or an integers representing the point-id.

safe

If TRUE, it will be tested, whether the given point-name (or point-id) is present in the 'tempflow'-object.

Value

The point-id of the point specified in "inpPoint", 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.