readScenarioConfigurationFromExcel: Read scenario definition(s) from excel file
In esqLABS/esqlabsR: esqLABS utilities package

View source: R/utilities-scenario-configuration.R

readScenarioConfigurationFromExcel

R Documentation

Read scenario definition(s) from excel file

Description

Read scenario definition(s) from excel file

Usage

readScenarioConfigurationFromExcel(scenarioNames = NULL, projectConfiguration)

Arguments

`scenarioNames`	Names of the scenarios that are defined in the excel file. If `NULL` (default), all scenarios specified in the excel file will be created.
`projectConfiguration`	A `ProjectConfiguration` object holding base information

Details

Reads scenario definition from the excel file defined in ProjectConfiguration and creates ScenarioConfiguration objects with new information. If a scenario that is specified in scenarioNames is not found in the excel file, an error is thrown.

Value

A named list of ScenarioConfiguration objects withe the names of the list being scenario names.

Examples

## Not run: 
# Create default ProjectConfiguration
projectConfiguration <- createProjectConfiguration()
scenarioName <- "MyScenario"
# Read scenario definition from excel
scenarioConfiguration <- readScenarioConfigurationFromExcel(scenarioConfiguration)[[scenarioName]]

## End(Not run)

esqLABS/esqlabsR documentation built on April 17, 2025, 10:51 a.m.