Get objects for use in the GUI — StoXGUI_interfaces • RstoxFramework

getModelNames and getModelInfo return the names and description of the StoX models.

getCanShowInMap: can the data produces by a process using this function be shown in the map?

getInteractiveData and getInteractiveMode get the interactive data and the mode of interactive data (data that canbe set and get iva the GUI) .

getMapData gets the data to plot in the map of the GUI.

getProcessPropertySheet gets the properties of a process.

setProcessPropertyValue gets the properties of a process.

getFunctionHelpAsHtml and getObjectHelpAsHtml get the R documentation of a StoX function or object as html for display in the GUI.

getFilterOptionsAll gets possible tables, operators and unique values for use in the filter expression builder.

getParameterTableInfo and getParameterVectorInfo get information of a parameter table or vector.

getModelInfo()

getInteractiveMode(projectPath, modelName, processID)

getInteractiveData(projectPath, modelName, processID)

getMapData(projectPath, modelName, processID)

getEDSUColours(n = 5, as.rgb = FALSE, col = c("pink", "red4", "darkorange2"))

getStationColours(
  n = 5,
  as.rgb = FALSE,
  col = c("steelblue2", "darkblue", "mediumvioletred")
)

getProcessPropertySheet(projectPath, modelName, processID)

setProcessPropertyValue(
  groupName,
  name,
  value,
  projectPath,
  modelName,
  processID
)

getFunctionHelpAsHtml(projectPath, modelName, processID, stylesheet = "")

getObjectHelpAsHtml(packageName, objectName, stylesheet = "")

getTableNames(projectPath, modelName, processID, warn = TRUE)

getFilterTableNames(projectPath, modelName, processID, warn = TRUE)

getFilterOptionsOneTable(
  projectPath,
  modelName,
  processID,
  tableName,
  include.integer = TRUE,
  include.numericInteger = TRUE,
  include.numeric = FALSE,
  include.POSIXct = FALSE,
  stopIfEmptyPossibleValues = FALSE
)

getParameterTableInfo(
  projectPath,
  modelName,
  processID,
  format,
  stopIfEmptyPossibleValues = FALSE
)

getParameterVectorInfo(
  projectPath,
  modelName,
  processID,
  format,
  stopIfEmptyPossibleValues = FALSE
)

getParameterSingleInfo(
  projectPath,
  modelName,
  processID,
  format,
  stopIfEmptyPossibleValues = 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.
n: The number of colour steps.
as.rgb: Logical: If TRUE return RGB table instead of HEX.
col: A vector of colour steps.
groupName: The name of the property group, one of "processArguments", "functionInputs" and "functionParameters".
name: The name of the property, such as "processName", "functionName", one of the process parameters ("enabled", "showInMap" and "fileOutput"), the name of a funciton input, or the name of a function parameter.
value: The value to set to the property (string).
stylesheet: The html stylesheet to use, defaulted to no stylesheet.
packageName: The package holding the object to get help as html for.
objectName: The R object to get help as html for.
warn: Logical: If TRUE show warnings that are not highly important.
tableName: The name of the output table to get from the process.
include.integer: Logical: If TRUE get possible values for integer variables. Default: TRUE.
include.numericInteger: Logical: If TRUE get possible values for numeric variables that are all whole numbers. Default: TRUE.
include.numeric: Logical: If TRUE get possible values for numeric variables. Default: FALSE
include.POSIXct: Logical: If TRUE get possible values for POSIXct variables. Default: FALSE
stopIfEmptyPossibleValues: Logical: If TRUE get possible values for numeric ariables as well as categorical variables.
format: A character string naming the format to get info for.