scenario: Create or open Scenario(s)

In rsyncrosim: The R Interface to 'SyncroSim'

Create or open Scenario(s)

Description

Create or open one or more Scenarios from a SsimLibrary.

Usage

scenario(
  ssimObject = NULL,
  scenario = NULL,
  sourceScenario = NULL,
  folder = NULL,
  summary = NULL,
  results = FALSE,
  forceElements = FALSE,
  overwrite = FALSE
)

Arguments

ssimObject	SsimLibrary or Project object, or character (i.e. a filepath)
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 NULL (Default), new Scenarios will be copies of the sourceScenario
folder	Folder object, character, or integer. The Folder object, name (must be unique), or Folder ID. If not NULL (Default), new Scenarios will be moved into the specified folder
summary	logical. If TRUE then loads and returns the Scenario(s) in a named vector/dataframe with the scenarioId, name, description, owner, dateModified, readOnly, parentID. Default is TRUE if scenario=NULL, FALSE otherwise
results	logical. If TRUE only return result Scenarios. Default is FALSE
forceElements	logical. If TRUE then returns a single Scenario as a named list; if FALSE (default), returns a single Scenario as a Scenario object. Applies only when summary=FALSE
overwrite	logical. If TRUE an existing Scenario will be overwritten. Default is FALSE

Details

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.

Value

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.

Examples

## Not run: 
# 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)

## End(Not run)

rsyncrosim documentation built on Oct. 7, 2023, 9:08 a.m.