getModelData: Get output data from processes of an open StoX project
In StoXProject/RstoxFramework: The Engine of StoX

getModelData

R Documentation

Get output data from processes of an open StoX project

Description

Get output data from processes of an open StoX project

Usage

getModelData(
  projectPath,
  modelName,
  processes = NULL,
  startProcess = 1,
  endProcess = Inf,
  drop.datatype = TRUE,
  warn = TRUE,
  unlistDepth2 = FALSE,
  returnBootstrapData = FALSE,
  selection = list(),
  BootstrapID = NA,
  unlistSingleTable = 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".
`returnBootstrapData`	Logical: If TRUE read the content of bootstrap NetCDF4 file.
`selection`	Hierarchical list of names of the groups/variables. The last element must be a vector of the variables to return from the table specified by the other elements. E.g., list("ImputeSuperIndividuals", "SuperIndividualsData", c("Stratum", "IndividualAge", "Abundance")) will return a data.table of the three columns "Stratum", "IndividualAge" and "Abundance", added the BootstrapID specified in `BootstrapID`.
`BootstrapID`	A sequence of bootstrap IDs, i.e., the indices of the bootstrap replicates. The default returns all bootstrap replicates.
`unlistSingleTable`	Logical: For use when only single table process outputs are among the requested processes in `OutputProcesses` of `Bootstrap`. If FALSE (default) return a list named by the `selection` with a sub-list named by the datatype holding the output data (e.g. $ImputeSuperIndividuals$SuperIndividualsData). If TRUE return a list named by the `selection` holding the output data, replicating the output of `Bootstrap` in StoX <= 3.6.2.