modifyProcess: Modify a process

In StoXProject/RstoxFramework: The Engine of StoX

Modify a process

Description

Modify a process

Usage

modifyProcess(
  projectPath,
  modelName,
  processName,
  newValues,
  archive = TRUE,
  add.defaults = FALSE,
  purge.processData = FALSE,
  strict = TRUE,
  update.functionInputs = TRUE
)

Arguments

projectPath	The path to the StoX project, i.e., the folder of the project with the sub folders "input", "output" and "process". Can possibly be the path to a file inside the project folder.
modelName	The name of the model (possible values are "baseline", "analysis" and "report").
processName	The name of the process.
newValues	A list named by the elements to modify (see getRstoxFrameworkDefinitions("processProperties") for possible elements), holding the values to modify to (e.g., list(functionParameter = list(DefinitionMethod = "Stratum"))).
archive	Logical: Should the project memory state be archived using archiveProject? This stores one step in the history.
add.defaults	Logical: If TRUE defaults of a function are added when setting the function of the process.
purge.processData	Logical: If TRUE replace process data entirely.
strict	Logical: If FALSE a proposed process name is changed to the default new process name, whereas TRUE throws an error.
update.functionInputs	Logical: If TRUE update the process name in the function inputs to other processes.

StoXProject/RstoxFramework documentation built on Oct. 17, 2023, 1:24 p.m.