prependProcess: Prepend (append before) to a process by adding another...

View source: R/Framework.R

prependProcessR Documentation

Prepend (append before) to a process by adding another process of the same function

Description

This method is only available for functions that has the same data type as input and output.

Usage

prependProcess(
  projectPath,
  modelName,
  processName,
  prependProcessName = paste(processName, "prepended", sep = "_"),
  values = NULL,
  returnProcessTable = 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.

prependProcessName

The name of process to prepend.

values

A list of zero or more of the following process arguments: functionParameters, processData, processParameters. The arguments functionInputs, functionName and processName are set as equal to the process given by processName.

returnProcessTable

Logical: If TRUE return the process table (much used in functions used by the GUI).


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