runLog: Retrieves run log of result Scenario

In syncrosim/rsyncrosim: The R Interface to 'SyncroSim'

Retrieves run log of result Scenario

Description

Retrieves the run log of a result Scenario.

Usage

runLog(scenario)

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

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

Arguments

scenario

Scenario object.

Value

A character string: the run log for a result scenario.

Examples

## Not run: 
# Set the file path and name of an existing SsimLibrary
myLibraryName <- file.path("MyLibrary.ssim")

# 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")

# Run Scenario
resultScenario <- run(myScenario)

# Retrieve the run log of the result Scenario
runLog(resultScenario)

## End(Not run)

syncrosim/rsyncrosim documentation built on Oct. 18, 2024, 1:29 a.m.