runProject | R Documentation |
This function runs and returns output from all models of a StoX project.
runProject(
projectPath,
modelNames = getRstoxFrameworkDefinitions("stoxModelNames"),
processes = NULL,
startProcess = 1,
endProcess = Inf,
drop.datatype = TRUE,
unlistDepth2 = FALSE,
run = TRUE,
save = TRUE,
force.save = FALSE,
force.restart = FALSE,
replaceDataList = list(),
replaceArgsList = list(),
prependProcessList = list(),
fileOutput = NULL,
setUseProcessDataToTRUE = TRUE,
purge.processData = FALSE,
returnModelData = TRUE,
returnBootstrapData = FALSE,
selection = list(),
BootstrapID = NA,
unlistSingleTable = FALSE,
try = TRUE,
close = FALSE,
unlist.models = TRUE,
msg = TRUE,
...
)
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. |
modelNames |
The name of the models (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. A list can be given named by the models if one needs to specify start process for each model. Models given inn |
endProcess |
The process index, name or ID at which to stop the model run. A list can be given named by the models if one needs to specify end process for each model. Models given inn |
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. |
unlistDepth2 |
Logical: Related to |
run |
Logical: If TRUE run the model. |
save |
Logical: If TRUE save the project before closing. Default (NULL) is to ask the user whether to save the project before closing. |
force.save |
If no changes are made to the project, force save anyway. Overrides the |
force.restart |
Logical: If TRUE, start the processes even if the status file indicating that the model is being run exists. This is useuful when something crached in a preivous run, in which case the model is still appearing as running. |
replaceDataList |
A list named by the processes to replace output data for. See |
replaceArgsList |
A list of |
prependProcessList |
A list of |
fileOutput |
Logical: If TRUE save the output as a text file (or other format specified by the class or attributes of the output). If NULL (defafult) use the corresponding parameter of the process. |
setUseProcessDataToTRUE |
Logical: If TRUE set the UseProcessData function parameter to TRUE in the process memory after execution, if the process is a ProcessData process. |
purge.processData |
Logical: If TRUE replace process data entirely. |
returnModelData |
Logical: If TRUE return the output of the model runs. Can also be given as a string vector holding the names of the models to return data from. If TRUE, the specific models to return data from (across models) can be given by |
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 |
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 |
try |
Logical: If FALSE do not run the process in a |
close |
Logical: (In |
unlist.models |
Logical: If TRUE unlist the top level so that all processes are in one list. |
msg |
Logical: If FALSE no messages are printed to console (except possibly for extremely important ones). |
... |
|
A list of model output.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.