Learn R Programming

rsyncrosim (version 1.2.9)

dependency: Set or remove Scenario dependency(s), or get existing dependencies.

Description

Set or remove Scenario dependency(s), or get existing dependencies.

Usage

dependency(scenario, dependency = NULL, remove = FALSE, force = FALSE)

# S4 method for character dependency(scenario, dependency = NULL, remove = FALSE, force = FALSE)

# S4 method for Scenario dependency(scenario, dependency = NULL, remove = FALSE, force = FALSE)

Arguments

scenario

character string, integer, or vector of these. Name or ID of scenario(s) to which a dependency is to be added (or has been already added if remove=TRUE). If NULL then ssimObject must be a Scenario. Note that integer ids are slightly faster.

dependency

Scenario, character string, integer, or list/vector of these. The scenario(s) that are the source of the dependency, in order from lowest to highest precedence. If NULL other arguments are ignored and the list of existing dependencies is returned.

remove

logical. If F (default) dependencies are added. If T, dependencies are removed.

force

logical. If F (default) prompt before removing dependencies.

Value

If dependency is NULL, a dataframe of existing dependencies, or list of these if multiple inputs are provided. If dependency is not NULL, the function invisibly returns a list bearing the names of the dependencies inputted and carrying a logical `TRUE` upon success (i.e.successful addition or deletion) and `FALSE` upon failure.

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.