set_graphList.tempnetwork: This function replaces the existing graph-list in the field...

Description Usage Arguments Value

View source: R/tempnetwork-setter.R

Description

This function replaces the existing graph-list in the field "graphList" of the given 'tempnetwork'-object by the given graph-list.

Usage

1
2
3
## S3 method for class 'tempnetwork'
set_graphList(tempNetwork, graphList,
  setDefaultGraphNames = TRUE, safe = TRUE)

Arguments

tempNetwork

A 'tempnetwork'-object.

graphList

A named list of "igraph"-objects.

setDefaultGraphNames

If TRUE any graph containing a vertex without a name, will be replaced by a graph where the name of each vertex is a string corresponding to its index in the respective 'igraph'-object. Moreover, any graph containing a vertex with a name that is not a string, will be coerced into a string.

safe

If TRUE, the usual 'tempnetwork' conditions will be checked.

Value

The given 'tempnetwork'-object where the existing graph-list in the field "graphList" of the given 'tempnetwork'-object is replaced by the given graph-list. If the parameter "graphList" is NULL the given unchanged 'tempnetwork'-object will be returned. Additionally, the "tempGraph"-field will be set to NULL.


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