Simulation object dependency diagram

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.

See also

DiagrammeR::mermaid.

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)
}
#> Setting:
#>   options(
#>     reproducible.cachePath = '/tmp/RtmpIQ0Aky/myProject/cache'
#>     spades.inputPath = '/tmp/RtmpIQ0Aky/myProject/inputs'
#>     spades.outputPath = '/tmp/RtmpIQ0Aky/myProject/outputs'
#>     spades.modulePath = '/tmp/RtmpIQ0Aky/myProject/modules'
#>     spades.scratchPath = '/tmp/RtmpIQ0Aky/SpaDES/scratch'
#>   )
#> Jan27 19:04:02 simInit Using setDTthreads(1). To change: 'options(spades.DTthreads = X)'.
#> Elpsed time for simInit: 0.02911425 secs

# }