rsyncrosim (version 1.2.9)

run: Run scenarios

Description

Run one or more SyncroSim scenarios.

Usage

run(
  ssimObject,
  scenario = NULL,
  summary = FALSE,
  jobs = 1,
  transformerName = NULL,
  forceElements = FALSE
)
# S4 method for character
run(
  ssimObject,
  scenario = NULL,
  summary = FALSE,
  jobs = 1,
  transformerName = NULL,
  forceElements = FALSE
)
# S4 method for list
run(
  ssimObject,
  scenario = NULL,
  summary = FALSE,
  jobs = 1,
  transformerName = NULL,
  forceElements = FALSE
)
# S4 method for SsimObject
run(
  ssimObject,
  scenario = NULL,
  summary = FALSE,
  jobs = 1,
  transformerName = NULL,
  forceElements = FALSE
)
# S4 method for BreakpointSession
run(ssimObject, scenario, summary, jobs, forceElements)

Arguments

ssimObject

SsimLibrary/Project/Scenario or a list of Scenarios. Or the path to a library on disk.

scenario

Character, integer, or vector of these. Scenario names or ids. Or NULL. Note that integer ids are slightly faster.

summary

Logical. If FALSE (default) result Scenario objects are returned. If TRUE (faster) result scenario ids are returned.

jobs

Integer. The number of jobs to run. Passed to SyncroSim where multithreading is handled.

transformerName

Character. The name of the transformer to run.

forceElements

Logical. If TRUE then returns a single result scenario as a named list; otherwise returns a single result scenario as a Scenario object. Applies only when summary=FALSE.

Value

If summary = FALSE, returns a result Scenario object or a named list of result Scenarios. The name is the parent scenario for each result. If summary = TRUE, returns summary info for result scenarios.

Details

Note that breakpoints are ignored unless ssimObject is a single scenario.