remove_gedges.tempnetwork: This function allows one to remove edges from the specified...

Description Usage Arguments Value

View source: R/tempnetwork-basic.R

Description

This function allows one to remove edges from the specified graphs contained in the graph-list of the given 'tempnetwork'-object. The vectors "pointNameList", "startTVertexList" and "endTVertexList" must all be of equal length, as their entries correspond with each other That is, the i-th entry from the vector "pointNameList" specifies the graph from which the i-th edge ought to be removed, while "startTVertexList" and "endTVertexList" characterise the start- and end-vertex of the i-th edge.

Usage

1
2
3
## S3 method for class 'tempnetwork'
remove_gedges(tempNetwork, pointNameList,
  startTVertexList, endTVertexList, safe = TRUE)

Arguments

tempNetwork

A 'tempnetwork'-object.

pointNameList

A vector of strings representing the names of points in the 'tempflow'-object of the given 'tempnetwork'-object.

startTVertexList

A vector of strings representing the names equivalence-classes in the equivalence-relation of the given 'tempnetwork'-object. Using the corresponding entries in the "pointNameList"-vector, said equivalence-relation will be queried to determine the start-vertices of the edges to be removed

endTVertexList

A vector of strings representing the names equivalence-classes in the equivalence-relation of the given 'tempnetwork'-object. Using the corresponding entries in the "pointNameList"-vector, said equivalence-realtion will be queried to determine the end-vertices of the edges to be removed

safe

If TRUE, it will be ensured that the vectors "pointNameList", "startTVertexList" and "endTVertexList" are of equal length; the specified edges actually exist in the corresponding graph;

Value

A new 'tempnetwork'-object, containing the same 'tempflow'-object as provided through the given 'tempnetwork'-object; a new graph-list constructed by removing the specified edges from the corresponding graphs in the graph-list of the given 'tempnetwork'-object; the same equivalence-relation as provided through the given 'tempnetwork'-object. Additionally, the "tempGraph"-field will be set to NULL.


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