Learn R Programming

SpaDES.core (version 3.0.4)

depsEdgeList: Build edge list for module dependency graph

Description

Build edge list for module dependency graph

Usage

depsEdgeList(sim, plot, includeOutputs = FALSE)

# S4 method for simList,logical depsEdgeList(sim, plot, includeOutputs = FALSE)

# S4 method for simList,missing depsEdgeList(sim, plot)

Value

A data.table whose first two columns give a list of edges and remaining columns the attributes of the dependency objects (object name, class, etc.).

Arguments

sim

A simList object.

plot

Logical indicating whether the edgelist (and subsequent graph) will be used for plotting. If TRUE, duplicated rows (i.e., multiple object dependencies between modules) are removed so that only a single arrow is drawn connecting the modules. Default is FALSE.

includeOutputs

Logical indicating whether objects that are only "outputs" will be kept and labelled as OUTPUTS analogous to INPUTS. This is relevant in the case of objectSynonyms. If an object is not used by another module then it will be removed from this depsEdgeList return; this keeps these so can be determined if they are e.g., suppliedElsewhere.

Author

Alex Chubaty