runProcess: Run one process

In StoXProject/RstoxFramework: The Engine of StoX

Run one process

Description

Run one process

Usage

runProcess(
  projectPath,
  modelName,
  processID,
  msg = TRUE,
  msg.GUI = FALSE,
  saveProcessData = TRUE,
  returnProcessOutput = FALSE,
  fileOutput = NULL,
  setUseProcessDataToTRUE = TRUE,
  purge.processData = FALSE,
  replaceArgs = list(),
  replaceData = NULL,
  try = 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").
processID	The ID of the process.
msg	Logical: If FALSE no messages are printed to console (except possibly for extremely important ones).
msg.GUI	Logical: If TRUE, exlcude certain messages (used by the StoX GUI).
saveProcessData	Logical: If TRUE save the output as ProcessData, if the proecss is a ProcessData process.
returnProcessOutput	Logical: If TRUE return the process output immediately after it is available. Used to get filter options.
fileOutput	Logical: If TRUE save the output as a text file (or other format specified by the class or attributes of the output). If NULL (defafult) use the corresponding parameter of the process.
setUseProcessDataToTRUE	Logical: If TRUE set the UseProcessData function parameter to TRUE in the process memory after execution, if the process is a ProcessData process.
purge.processData	Logical: If TRUE replace process data entirely.
replaceArgs	A list of function parameters and inputs to override.
replaceData	Either the data to replace the process output by, or a list of two elements FunctionName and MoreArgs, giving a function to apply to the output from the process with additional arguments stored in MoreArgs. The function is applied using do.call, with args being a list with the process output first, followed by the MoreArgs.
try	Logical: If FALSE do not run the process in a tryCatch. Set this to FALSE when debugging, as the tryCatch masks the errors in the traceback.

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