induce_flow.tempflow: Is a function that takes a 'tempflow'-object and a vector of...

Description Usage Arguments Value

View source: R/tempflow-basics.R

Description

Is a function that takes a 'tempflow'-object and a vector of point-names (or point-ids) and restricts the given flow to the sub-flow induced by the vector of points. That is, the underlying 'igraph'-object will be restricted to a graph containing only the vertices corresponding to the specified points.

Usage

1
2
## S3 method for class 'tempflow'
induce_flow(tempFlow, inpPointList, safe = TRUE)

Arguments

tempFlow

A 'tempflow'-object.

inpPointList

A vector containing point-names (or point-ids).

safe

If TRUE, it will be ensured that all the specified points exist in the 'tempflow'-object and that all relevant 'tempflow'-conditions are uphold.

Value

A new 'tempflow'-object, obtained by restricting the underlying 'igraph'-object to the vertices corresponding to the points specified in the "inpPointList"-vector.


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