slice_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 start-points in time and a vector of end-points in time. Given those, the cross-product of "startPointList" and "endPointList" will be computed, from there any point that lies between the points of any tuple will be included in the new 'tempflow'-object. Given those, a new flow will be returned that contains all points (including start point and end point).

Usage

1
2
3
## S3 method for class 'tempflow'
slice_flow(tempFlow, startPointList, endPointList,
  safe = TRUE)

Arguments

tempFlow

A 'tempflow'-object.

startPointList

A vector containing point-names (or point-ids) representing the names of the start-points of the new 'tempflow'-object.

endPointList

A vector containing point-names (or point-ids) representing the names of the end-points of the new 'tempflow'-object.

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, reduced to the points in time between the "startPoint" and the "endPoint".


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