delete_steps.tempnetwork: Is a function that takes a 'tempnetwork'-object and two...

Description Usage Arguments Value

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

Description

Is a function that takes a 'tempnetwork'-object and two vectors of point-names (or point-ids) and removes the steps from the 'tempflow'-object of the given 'tempnetwork'-object. The steps are characterised by the points in the "srcPointList"-vector and the corresponding points in the "dstPointList"-vector,

Usage

1
2
3
## S3 method for class 'tempnetwork'
delete_steps(tempNetwork, srcPointList, dstPointList,
  safe = TRUE)

Arguments

tempNetwork

A 'tempnetwork'-object.

srcPointList

A vector containing the point-names (or point-ids) of the start-points of the edges that ought to be removed.

dstPointList

A vector containing the point-names (or point-ids) of the end-points of the edges that ought to be removed.

safe

If TRUE, it will be ensured that the specified point-names (or point-ids) are present in the 'tempflow'-object of the given 'tempnetwork'-object; that the specified steps exist; the "srcPointList"-vector, the "dstPointList"-vector are of the same length. Additionally, the usual tempflow and tempnetwork condition are checked.

Value

A new 'tempnetwork'-object, containing a new 'tempflow'-object constructed by removing the specified edges from the 'tempflow'-object of the given 'tempnetwork'-object.


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