scenarioId: Retrieves scenarioId of Scenario
In rsyncrosim: The R Interface to 'SyncroSim'

scenarioId

R Documentation

Retrieves scenarioId of Scenario

Description

Retrieves the scenarioId of a Scenario.

Usage

scenarioId(scenario)

## S4 method for signature 'character'
scenarioId(scenario)

## S4 method for signature 'Scenario'
scenarioId(scenario)

Arguments

scenario

Scenario object

Value

Integer id of the input Scenario.

Examples

## Not run: 
# 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()
myLibrary <- ssimLibrary(name = myLibraryName, session = mySession) 
myProject <- project(myLibrary, project = "Definitions")
myScenario <- scenario(myProject, scenario = "My Scenario")

# Get Scenario ID of Scenario
scenarioId(myScenario)

## End(Not run)

rsyncrosim documentation built on Oct. 15, 2024, 1:06 a.m.