resetModel: Reset a StoX model.

In StoXProject/RstoxFramework: The Engine of StoX

Reset a StoX model.

Description

Reset a StoX model.

Usage

resetModel(
  projectPath,
  modelName,
  processID = NULL,
  processDirty = FALSE,
  shift = 0,
  returnProcessTable = FALSE,
  delete = c("memory", "text"),
  deleteCurrent = FALSE,
  purgeOutputFiles = 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").
processID	The ID of the process.
processDirty	Logical: Indicates whether the model has been modified when resetting. Tf the process to reset to is after the active process,
shift	The position relative to the current memory status to un/redo to.
returnProcessTable	Logical: If TRUE return the process table (much used in functions used by the GUI).
delete	A character vector naming which elements to delete, where possible values are "memory", for deleting the output files that are stored as memory files, and "text" to delete the output text files.
deleteCurrent	Logical: If TRUE delete process output also of the process given by processID.
purgeOutputFiles	Logical: If the model has not been run, should the output text files be deleted first. This was used at an earlier stage, when there was not complete control of how process output was deleted, and data were frequently not deleted eevn though the process was deleted.

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