getProcess: Get the properties of a StoX process

View source: R/Framework.R

getProcessR Documentation

Get the properties of a StoX process

Description

This function lists the process name, the function name, the process parameters, the function parameters, the function inputs and the process data of a StoX process.

Usage

getProcess(projectPath, modelName, processName, only.valid = 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").

processName

The name of the process.

only.valid

Logical: If TRUE return only the valid arguments, which are those visible in the GUI.


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