objectDiagram: Simulation object dependency diagram

In SpaDES.core: Core Utilities for Developing and Running Spatially Explicit Discrete Event Models

Simulation object dependency diagram

Description

Create a sequence diagram illustrating the data object dependencies of a simulation. Offers a more detailed view of specific objects than does plotting the depsEdgeList directly with moduleDiagram().

Usage

objectDiagram(sim, ...)

## S4 method for signature 'simList'
objectDiagram(sim, ...)

Arguments

sim	A simList object (typically corresponding to a completed simulation).
...	Additional arguments passed to DiagrammeR::mermaid. Useful for specifying height and width.

Value

Plots a sequence diagram, invisibly returning a DiagrammeR::mermaid object.

Author(s)

Alex Chubaty

See Also

DiagrammeR::mermaid.

Examples

if (requireNamespace("DiagrammeR", quietly = TRUE)) {
  sim <- simInit()
  objectDiagram(sim)
  # if there are lots of objects, may need to increase width and/or height
  objectDiagram(sim, height = 3000, width = 3000)
}

SpaDES.core documentation built on June 22, 2024, 10:32 a.m.