ProjectUtils: Utilities for projects.

In StoXProject/RstoxFramework: The Engine of StoX

Utilities for projects.

Description

Utilities for projects.

Read the project description.

Initiate the actige processID.

Check or set if a project is running or not.

Usage

isProject(projectPath)

isSaved(projectPath)

isOpenProject(projectPath, strict = FALSE)

readProjectDescription(
  projectPath,
  verbose = FALSE,
  projectDescriptionFile = NULL,
  applyBackwardCompatibility = TRUE,
  formatProcesses = TRUE,
  validateJSON = TRUE
)

initiateActiveProcessID(projectPath)

isRunning(projectPath, modelName)

setRunning(projectPath, modelName)

setNotRunning(projectPath, modelName)

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.
strict	Logical: If TRUE, require that all folders of the projectSession folder exist in isOpenProject(). Otherwise only require that the projectSession folder exists.
verbose	Logical: If TRUE extra messages are printed to console.
projectDescriptionFile	The path to the file holding the projectDescription.
applyBackwardCompatibility	Logical: If TRUE apply backward compatibility actions when running readProjectDescription.
formatProcesses	Logical: If TRUE format the processes after reading the projectDescription file, ensuring correct primitive types. This has a use of FALSE in readModelData, but should otherwise be set to TRUE.
validateJSON	Logical: If TRUE validate the project.json.
modelName	The name of the model (possible values are "baseline", "analysis" and "report").

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