scenario | R Documentation |
Create or open one or more Scenario
s from a
SsimLibrary
.
scenario( ssimObject = NULL, scenario = NULL, sourceScenario = NULL, summary = NULL, results = FALSE, forceElements = FALSE, overwrite = FALSE )
ssimObject |
|
scenario |
character, integer, or vector of these. Names or ids of one or more Scenarios. Note integer ids are slightly faster, but can only be used to open existing Scenarios |
sourceScenario |
character or integer. If not |
summary |
logical. If |
results |
logical. If |
forceElements |
logical. If |
overwrite |
logical. If |
For each element of Scenario:
If element/Project/SsimObject uniquely identifies an existing Scenario: Returns the existing Scenario.
If element/Project/SsimObject uniquely identifies more than one existing Scenario: Error.
If element/Project/SsimObject do not identify an existing Scenario or Project: Error.
If element/Project/SsimObject do not identify an existing Scenario and element is numeric: Error - a name is required for new Scenarios. SyncroSim will automatically assign an id when a Scenario is created.
If element/Project/SsimObject do not identify an existing Scenario and
do identify a Project, and element is a character string: Creates a
new Scenario named element in the Project. SyncroSim automatically
assigns an id. If sourceScenario is not NULL
the new Scenario will be
a copy of sourceScenario.
A Scenario
object representing a SyncroSim scenario, a list of Scenario
objects, or a data frame of Scenario names and descriptions. If summary = FALSE
,
returns one or more Scenario
objects representing SyncroSim Scenarios.
If summary = TRUE
, returns Scenario summary info.
# Set the file path and name of the new SsimLibrary myLibraryName <- file.path(tempdir(),"testlib") # Set the SyncroSim Session, SsimLibrary, and Project mySession <- session() myLibrary <- ssimLibrary(name = myLibraryName, session = mySession) myProject <- project(myLibrary, project = "My Project") # Create a new Scenario myScenario <- scenario(myProject, scenario = "My Scenario") # Create a new Scenario from an existing Scenario myScenarioCopy <- scenario(myProject, scenario = "My Scenario Copy", sourceScenario = myScenario) # Find all the Scenarios in a SsimLibrary scenario(myLibrary) # Only return the results Scenarios for a SsimLibrary scenario(myLibrary, results = TRUE) # Overwrite an existing Scenario myNewScenario <- scenario(myProject, scenario = "My New Scenario", overwrite = TRUE)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.