run | R Documentation |
Run one or more SyncroSim Scenario
(s).
run( ssimObject, scenario = NULL, summary = FALSE, jobs = 1, copyExternalInputs = FALSE, transformerName = NULL, forceElements = FALSE ) ## S4 method for signature 'character' run( ssimObject, scenario = NULL, summary = FALSE, jobs = 1, copyExternalInputs = FALSE, transformerName = NULL, forceElements = FALSE ) ## S4 method for signature 'list' run( ssimObject, scenario = NULL, summary = FALSE, jobs = 1, copyExternalInputs = FALSE, transformerName = NULL, forceElements = FALSE ) ## S4 method for signature 'SsimObject' run( ssimObject, scenario = NULL, summary = FALSE, jobs = 1, copyExternalInputs = FALSE, transformerName = NULL, forceElements = FALSE ) ## S4 method for signature 'BreakpointSession' run(ssimObject, scenario, summary, jobs, copyExternalInputs, forceElements)
ssimObject |
|
scenario |
character, integer, or vector of these. Scenario names or ids.
If |
summary |
logical. If |
jobs |
integer. The number of jobs to run. Passed to SyncroSim where multithreading is handled |
copyExternalInputs |
logical. If |
transformerName |
character. The name of the transformer to run (optional) |
forceElements |
logical. If |
Note that breakpoints are ignored unless the SsimObject is a single Scenario.
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.
## Not run: # Install helloworldSpatial package addPackage("helloworldSpatial") # Set the file path and name of the new SsimLibrary myLibraryName <- file.path(tempdir(),"testlib") # Set the SyncroSim Session, SsimLibrary, Project, and Scenario mySession <- session(printCmd=T) myLibrary <- ssimLibrary(name = myLibraryName, session = mySession, package = "helloworldSpatial", template = "example-library") myProject <- project(myLibrary, project = "Definitions") myScenario <- scenario(myProject, scenario = "My Scenario") # Run with default parameters resultScenario <- run(myScenario) # Only return summary information resultScenario <- run(myScenario, summary = TRUE) # Run with multiprocessing resultScenario <- run(myScenario, jobs = 6) # Return results as a named list resultScenario <- run(myScenario, forceElements = TRUE) ## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.