remove_point.tempnetwork: This function takes a 'tempnetwork'-object and a point-name...

Description Usage Arguments Value

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

Description

This function takes a 'tempnetwork'-object and a point-name (or point-id), which will be removed from the 'tempflow'-object of the given 'tempnetwork'-object. If the point has only a successor or only a predecessor, then only the incident edges will be removed. Otherwise, all successors and all predecessors will be connected in a manner such that distances, i.e. weights are preserved. Additionally, the corresponding entry in the "graphList" and in the "equivRel" of the given 'tempnetwork'-object will be removed as well.

Usage

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

Arguments

tempNetwork

A 'tempnetwork'-object.

removePoint

A point-name (or point-id) representing the point in time to be removed.

safe

If TRUE, it will be ensured, that the given point is present in the specified 'tempflow'-object. Additionally, the usual tempflow and tempnetwork condition are checked.

Value

A new 'tempnetwork'-object, containing a new 'tempflow'-object constructed by removing the specified point and (if necessary) reconnecting the 'tempflow'-object of the given 'tempnetwork'-object; containing a new "graphList" constructed by removing the graph with the name of the specified point from the existing "graphList" of the given 'tempnetwork'-object; containing a new "equivRel" constructed by removing the entries corresponding to the vertices of the removed graph from the existing "equivRel" of the given 'tempnetwork'-object.


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