dependency: Get, set or remove Scenario dependency(s)

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

Get, set or remove Scenario dependency(s)

Description

List dependencies, set dependencies, or remove dependencies from a SyncroSim Scenario. Setting dependencies is a way of linking together Scenario Datafeeds, such that a change in the Scenario that is the source dependency will update the dependent Scenario as well.

Usage

dependency(ssimObject)

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

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

dependency(ssimObject) <- value

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

Arguments

ssimObject	Scenario object, character string, integer, or vector of these. The Scenario object, name, or ID to which a dependency is to be added (or has already been added if remove=TRUE). Note that integer ids are slightly faster.
value	Scenario object, character string, integer, or vector of these. The Scenario object, name, or ID to be used as the dependency. If an empty vector is provided, all dependencies are removed.

Details

If dependency==NULL, other arguments are ignored, and set of existing dependencies is returned in order of precedence (from highest to lowest precedence). Otherwise, returns list of saved or error messages for each dependency of each scenario.

Note that the order of dependencies can be important - dependencies added most recently take precedence over existing dependencies. So, dependencies included in the dependency argument take precedence over any other existing dependencies. If the dependency argument includes more than one element, elements are ordered from lowest to highest precedence.

Value

A data.frame: all dependencies for a given Scenario

Examples

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

# Set up a SyncroSim Session, SsimLibrary, Project, and 2 Scenarios
mySession <- session()
myLibrary <- ssimLibrary(name = myLibraryName, session = mySession)
myProject <- project(myLibrary, project = "Definitions")
myScenario <- scenario(myProject, scenario = "My Scenario")
myNewScenario <- scenario(myProject,
                          scenario = "my New Scenario")

# Set myScenario as a dependency of myNewScenario
dependency(myNewScenario) <- myScenario

# Get all dependencies info
dependency(myNewScenario)

# Remove all dependencies
dependency(myNewScenario) <- c()

## End(Not run)

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