delete_points.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 removes the specified points from the 'tempflow'-object.

Usage

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

Arguments

tempFlow

A 'tempflow'-object.

deletePointList

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

safe

If TRUE, it will be ensured that the specified point-names (or point-ids) are present in the given 'tempflow'-object. Additionally, the usual tempflow condition are checked (e.g. duplicate names, cycles, ... ).

attrList

A vector to specify other vertex attributes. If left NULL, no attributes (other than name) will be assigned to the newly introduced points in time. Otherwise, this list has to be structured as required by the function igraph::add.vertices.

Value

A new 'tempflow'-object, constructed by removing the specified points from the given 'tempflow'-object.


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