add_scenario: Add a scenario or update a scenario in the scenario list by...

View source: R/funcs_scenarios.R

add_scenarioR Documentation

Add a scenario or update a scenario in the scenario list by name

Description

Add a scenario or update a scenario in the scenario list by name

Usage

add_scenario(scenario_list, scenario, user_name = NULL)

Arguments

scenario_list

List where each element is a scenario list-object.

scenario

A scenario list-object.

user_name

Character string with the name of the scenario to be added or updated.

Value

If the 'scenario' is valid, an updated scenario list If not, a character string equal to "error: your scenario is not complete, please review".

Examples

## Not run: 
add_scenario(scenario_list, scenario, user_name = "my new scenario")

## End(Not run)

cath-parkinson/mm.reoptimise documentation built on May 12, 2022, 3:34 p.m.