remove_tvertices.tempnetwork: This function takes a list of equivalence-class names (i.e....

Description Usage Arguments Value

View source: R/tempnetwork-basic.R

Description

This function takes a list of equivalence-class names (i.e. tempvertices) and creates a new 'tempnetwork'-object by removing the specified equivalence-classes from the equivalence-relation of the given 'tempnetwork'-object; removing all vertices contained in in the specified equivalence-classes from their respective graphs in the graph-list of the given 'tempnetwork'-object.

Usage

1
2
3
## S3 method for class 'tempnetwork'
remove_tvertices(tempNetwork, tVertexNameList,
  safe = TRUE)

Arguments

tempNetwork

A 'tempnetwork'-object.

tVertexNameList

A vector of strings representing the names of equivalence-classes in the equivalence-relation of the given 'tempnetwork'-object.

safe

If TRUE, it will be ensured that the names in the vector "tVertexNameList" are actually names of equivalence-classes in the equivalence-relation of the given 'tempnetwork'-object; the vector "tVertexNameList" does not contain duplicates. the resulting 'tempnetwork'-object satisfies all tempnetwork conditions.

Value

A new 'tempnetwork'-object, containing the same 'tempflow'-object as the one given through the provided 'tempnetwork'-object; a graph-list constructed by removing the vertices contained in the given equivalence-classes from their respective graph in the graph-list of 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.