addProcess: Add a StoX process to a model.

In StoXProject/RstoxFramework: The Engine of StoX

Add a StoX process to a model.

Description

Add a StoX process to a model.

Usage

addProcess(
  projectPath,
  modelName,
  values = NULL,
  returnProcessTable = TRUE,
  archive = TRUE,
  add.defaults = FALSE,
  strict = TRUE,
  afterProcessID = NULL,
  beforeProcessID = NULL
)

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").
values	A list of values to assign to the process, such as list(processName = "ReadBiotic", functionName = "RstoxBase::ReadBiotic").
returnProcessTable	Logical: If TRUE return the process table.
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.
strict	Logical: If FALSE a proposed process name is changed to the default new process name, whereas TRUE throws an error.
afterProcessID	The ID of the process after which to get the process table or to place a process.
beforeProcessID	The ID of the process before which to get the process table.

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