initializeCopyScenario: Initialize a new scenario by copying an existing scenario.

Description Usage Arguments Details Value

View source: R/fsdm.R

Description

initializeCopyScenario initializes a new scenario by creating a directory with the scenario name and copying the contents of an existing scenario into that directory.

Usage

1
2
initializeCopyScenario(ModelsDir, ModelName, ConceptVars_, ScenarioName,
  CopyScenarioName, NumIncr)

Arguments

ModelsDir

a string identifying the path to the models folder in which the model is located.

ModelName

a string representation of the model name.

ConceptVars_

a string vector of the model concept variable names.

ScenarioName

a string representation of the new scenario name.

CopyScenarioName

a string representation of the name of the scenario to copy.

NumIncr

an integer identifying the number of growth increments for the scenario.

Details

This function initializes a new scenario with the given scenario name from an existing scenario. It does this by creating a directory with the scenario name and copying the scenario files for an existing scenario into it. It creates a new scenario status list which identifies the name of the new scenario and the name of the parent scenario it is a copy of. It also identifies the number of growth increments in the new scenario.

Value

a list containing a status list and a scenario values data frame.


gregorbj/FSDM documentation built on May 25, 2021, 11:41 p.m.