mergeDependencies: Merge dependencies for a Scenario

In rsyncrosim: The R Interface to 'SyncroSim'

Merge dependencies for a Scenario

Description

Retrieves or sets whether or not a Scenario is configured to merge dependencies at run time.

Usage

mergeDependencies(ssimObject)

## S4 method for signature 'character'
mergeDependencies(ssimObject)

## S4 method for signature 'Scenario'
mergeDependencies(ssimObject)

mergeDependencies(ssimObject) <- value

## S4 replacement method for signature 'character'
mergeDependencies(ssimObject) <- value

## S4 replacement method for signature 'Scenario'
mergeDependencies(ssimObject) <- value

Arguments

ssimObject	Scenario object
value	logical. If TRUE the Scenario will be set to merge dependencies at run time. Default is FALSE

Value

A logical: TRUE if the scenario is configured to merge dependencies at run time, and FALSE otherwise.

Examples

## Not run: 
# Specify file path and name of new SsimLibrary
myLibraryName <- file.path(tempdir(),"testlib")

# Set up a 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")

# Retrieve whether or not dependencies will be merged for a Scenario
mergeDependencies(myScenario)

# Set whether or not dependencies will be merged for a Scenario
mergeDependencies(myScenario) <- TRUE

## End(Not run)

rsyncrosim documentation built on May 29, 2024, 10:23 a.m.