getModelData: Get output data from processes of a StoX model

In StoXProject/RstoxFramework: The Engine of StoX

Get output data from processes of a StoX model

Description

Get output data from processes of a StoX model

Usage

getModelData(
  projectPath,
  modelName,
  processes = NULL,
  startProcess = 1,
  endProcess = Inf,
  drop.datatype = TRUE,
  warn = TRUE,
  unlistDepth2 = FALSE
)

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").
processes	The name of the processes.
startProcess	The process index, name or ID at which to start the model run.
endProcess	The process index, name or ID at which to stop the model run.
drop.datatype	Logical: If TRUE, drop the top level of the output list if it has length 1 and that single element is named by the datatype name.
warn	Logical: If TRUE show warnings that are not highly important.
unlistDepth2	Logical: Related to drop.datatype, but setting this to TRUE unlists output data that are nested in 2 levels, such as output from ReadBiotic, which outputs a set of tables for each input file. Using unlistDepth2 = TRUE puts all these tables in one list, and uses the concatenation of the file names and the table name separated by underscore. This is how it is displayed in the StoX GUI when selecting "View output".

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