Skip to contents

Generate a new scenario object

Source: R/class-scenario.R
newScenario.Rd

Generate a new scenario object

Usage

newScenario(
  name,
  model = NULL,
  path = fp(get_scenarios_path(), name),
  ...,
  env_name = ".scen",
  registry = get_registry(),
  replace = FALSE
)

Arguments

name

character. Name of the scenario.

path

character. Path to the scenario directory.

...
env_name

name of the environment to assign the scenario in.

registry

optional registry object to register the scenario.

replace

logical. If TRUE, replace the entry of the scenario in the registry if the entry already exists.