Simulation object dependency diagram

Source: R/plotting-diagrams.R

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().

objectDiagram(sim, ...)

# S4 method for class '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

Alex Chubaty

Examples

# \donttest{
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)
}
#> Elapsed time for simInit: 0.02498841 secs


# }