construct_underlying_graph.tempnetwork: This function constructs a graph representation of the given...

In KonstantinRK/tempnetwork:

Description

This function constructs a graph representation of the given 'tempnetwork'-object. This is accomplished by renaming all vertices (as specified in the function "base_get_tempgraph_vertex_name"), adding the attributes "vertexName", "pointName" and "tempVertexName" according to their position in the equivalence-relation of the given 'tempnetwork'-object. After this all edited graphs are merged (using igraph::disjoint_union). Moreover, if connectGraphs is TRUE, for each equivalence-classe all contained vertices are connected in the exact same manner as provided by the 'tempflow'-object of the given 'tempnetwork'-object.

Usage

## S3 method for class 'tempnetwork'
construct_underlying_graph(tempNetwork,
  connectGraphs = TRUE, forceIGraph = FALSE)

Arguments

tempNetwork	A 'tempnetwork'-object.
connectGraphs	If TRUE, for each equivalence-classe all contained vertices are connected in the exact same manner as provided by the 'tempflow'-object of the given 'tempnetwork'-object.
forceIGraph	If TRUE, the function will always return an 'igraph'-object.

Value

If "forceIGraph" is TRUE or if the field "storeTempGraph" is FALSE, this function returns an 'igraph'-object as described above. Otherwise, this function will return a 'tempnetwork'-object that is identical to the given 'tempnetwork'-object, but for the fact that the field "tempGraph" contains an 'igraph'-object as described above.

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