Package index • RstoxFramework

All functions
`addAcousticPSU()` `removeAcousticPSU()` `addEDSU()` `removeEDSU()`	Add, remove and renamme acoustic PSUs and EDSUs
`addHaulToAssignment()` `removeHaulFromAssignment()`	Add or remove biotic hauls to/from assignment of hauls to acoustic PSU/Layer
`addBioticPSU()` `removeBioticPSU()` `addStation()` `removeStation()`	Add, remove and renamme biotic PSUs and Stations
`Bootstrap()`	Bootstrap the baseline model, write to NetCDF4 file
`BootstrapData`	Bootstrap data
`DataTypes`	StoX data types of the RstoxFramework package
`KnownDifferencesOldVersusNewStoX`	Known differences between StoX 2.7 and the new StoX >= 3.0.0
`ModelData`	Model data generated by RstoxFramework
`PlotReportBootstrap()`	Plot ReportBootstrapData
`PlotReportBootstrapData`	Plot of reported Bootstrap data
`ProcessData`	Process data used by RstoxFramework
`isProject()` `isSaved()` `isOpenProject()` `readProjectDescription()` `initiateActiveProcessID()` `isRunning()` `setRunning()` `setNotRunning()`	Utilities for projects.
`createProject()` `openProject()` `openProjectAsTemplate()` `closeProject()` `saveProject()` `saveAsProject()` `copyProject()` `deleteProject()` `getProject()`	Create, open, close, save, saveAs, copy and delete a StoX project.
`ReportBootstrap()`	Report Bootstrap
`ReportBootstrapData`	Reported Bootstrap data
`ResampleBioticAssignmentByAcousticPSU()`	Resamples biotic PSUs
`ResampleBioticAssignmentByStratum()`	Resamples biotic PSUs
`ResampleMeanLengthDistributionData()`	Resamples biotic PSUs within Stratum in MeanLengthDistributionData
`ResampleMeanNASCData()`	Resamples acoustic PSUs
`ResampleMeanSpeciesCategoryCatchData()`	Resamples biotic PSUs within Stratum in MeanSpeciesCategoryCatchData
`ResamplePreySpeciesCategoryCatchDataHierarchical()`	Resamples biotic PSUs within Stratum in MeanSpeciesCategoryCatchData
`ResamplePreySpeciesCategoryCatchDataHierarchicalNotUsingmakeUniqueVars()`	Resamples biotic PSUs within Stratum in MeanSpeciesCategoryCatchData
`ResamplePreySpeciesCategoryCatchDataHierarchicalUsingScaling()`	Resamples biotic PSUs within Stratum in MeanSpeciesCategoryCatchData
`RstoxFramework-package` `RstoxFramework`	The Engine of StoX
`RstoxPackageStatus()`	Get package status of an Rstox package
`getModelInfo()` `getInteractiveMode()` `getInteractiveData()` `getMapData()` `getEDSUColours()` `getStationColours()` `getProcessPropertySheet()` `setProcessPropertyValue()` `getFunctionHelpAsHtml()` `getObjectHelpAsHtml()` `getTableNames()` `getFilterTableNames()` `getFilterOptionsOneTable()` `getParameterTableInfo()` `getParameterVectorInfo()` `getParameterSingleInfo()`	Get objects for use in the GUI
`addStratum()` `removeStratum()` `modifyStratum()` `renameStratum()`	Stratum manipulation
`addProcess()`	Add a StoX process to a model.
`bootstrapRDataToNetCDF4()`	Convert a bootstrap RData file to NetCDF4. THIS FUNCTION IS NOT FINISHED, AND SHOULD NOT BE!!!
`compareProjectToStoredOutputFiles()`	Function for comparing existing output files with the memory read using runProject()
`compareProjectToStoredOutputFilesAll()`	Function for comparing existing output files with the memory read using runProject()
`compareSweptAreaBaseline()`	Compare processes in a StoX 2.7 project and a copy in StoX >= 3.0.0:
`convertKeys2.7To3()`	Convert keys of a 2.7 table to mimic the keys of StoX >= 3
`convertStoX2.7To3()`	Backward compabitibility actions:
`duplicateProcess()`	Duplicate a StoX process.
`estimateTimeOfProcesses()`	Get process progress
`expandDT()`	Function to expand a data table so that the cells that are vectors are transposed and the rest repeated to fill the gaps
`expandProcess()`	Insert a StoX process after a specific process
`expression2list()`	Parse an R expression to a nested list:
`extractErrorIDs()`	Get IDs of bad Hauls or Samples
`extractPackageNameAsNames()`	Small function to parse the string defining officical Rstox-package versions (for each RstoxFramwork):
`findProcess()`	Find a processes from processName or functionName
`fixedWidthTable()`	Function to convert data.table to fixed width:
`general_arguments`	General parameters of RstoxFramework.
`getActiveProcess()`	Get the active process.
`getAvaiableTemplates()`	Get avilable templates.
`getAvailableStoxFunctionNames()`	Function returning the names of the StoX functions available for a model:
`getBootstrapOutputVariables()`	Get variables used in reports, specifically for use in the argument OutputVariables in Bootstrap()
`getModelData()`	Get output data from processes of an open StoX project
`getOfficialRstoxPackageVersion()`	Get certified Rstox package versions
`getOutputVariablesUsedInReport()`	List variables used in the reports of a project
`getProcess()`	Get the properties of a StoX process
`getProcessIDByOffset()`	Function to get process index from process ID
`getProcessIDFromFunctionName()`	Get process ID from function name
`getProcessIDFromProcessName()`	Function to get process ID from process name
`getProcessIndexFromProcessID()`	Function to get process index from process ID
`getProcessNameFromProcessID()`	Function to get process name from process ID
`getProcessOutput()` `getProcessTableOutput()` `getProcessGeoJsonOutput()`	Get output of a StoX process.
`getProcessOutputElements()`	Get the names of the output tables of a process
`getProcessOutputFiles()`	Function to get all process output memory files of a process:
`getProcessOutputFolder()`	Find the output folder of a process
`getProcessOutputTableNames()`	Get the names of the output tables of a process
`getProcessPlotOutput()`	Get output of a StoX process.
`getProcessTable()` `scanForModelError()` `getProcessesSansProcessData()` `getProcessAndFunctionNames()`	Functions to get the process table of a model.
`getProjectPaths()`	This function gets the paths defined by `initiateRstoxFramework`.
`getRelevantClass()`	Function to get the first class of the object x, except if the class "gg" is returned in which case "ggplot" is returned instead if present as one of the classes of the object:
`getResamplableProcesses()`	Utility function for processPropertyFormats. This is exported in order for processPropertyFormats to be albe to use it:
`getResampleFunctions()`	Utility function for processPropertyFormats. This is exported in order for processPropertyFormats to be able to use it:
`getRstoxFrameworkDefinitions()`	Get RstoxFramework definitions
`getSubPlotNames_PlotReportBootstrap()`	List PlotReportBootstrap plots
`getTemplate()`	Get a template.
`hasFileOutput()`	Does the process store output files?:
`initiateRstoxFramework()`	Definitions stored in the RstoxFramework environment
`json2expression()`	Function to convert from json to R expression:
`list2expression()`	Function to convert from R list to R expression:
`modifyModel()`	Modify a model
`modifyProcess()`	Modify a process
`modifyProject()`	Modify a project
`modifyProjects()`	Modify multiple projects
`parseParameter()`	Function to parse a parameter coming from the GUI
`prependProcess()`	Prepend (append before) to a process by adding another process of the same function
`processPropertyFormats`	Process property formats for RstoxFramework
`progressOfProcesses()`	Get process progress
`purgeOutput()`	Delete the contents of the output folder of a model.
`readBootstrapData()`	Get bootstrap data saved in a NetCDF4 file
`readMemoryFile()`	Read a StoX memory file
`readModelData()`	Read the output files of a project
`readOfficialRstoxPackageVersionsFile()`	Get certified Rstox package versions
`readProcessOutputFile()`	Function to read a single process output file, possibly by pages and in flattened and pretty view:
`readStoX2.7OutputFile()`	Read output file from StoX 2.7
`rearrangeProcesses()`	Rearrange processes of a StoX model.
`removeProcess()`	Remove a StoX process
`removeProcesses()`	Remove a StoX process
`resetModel()`	Reset a StoX model.
`runFunction()` `runFunction.JSON()`	General functions to run a function of an Rstox package, modeled by do.call().
`runModel()`	Run a model of a StoX project
`runProcess()`	Run one process
`runProcesses()`	Run processes of a model.
`runProject()`	Run all models of a StoX project
`runProject_ReplaceAcousticFiles()`	Add a process DefineAcousticPSU with DefinitionMethod "PreDefined"
`runProjects()`	Run all models of a StoX project
`stopProcesses()`	Stop runProcesses().
`stoxFunctionAttributes`	A list of the attributes of the exported StoX functions:
`subsetByAllEqual()`	Remove columns where all values are equal both in the x and y element of the input
`unReDoProject()`	Function to undo or redo, i.e., reset the current project description file and change the indices. There will be separate GUI functions for undo and redo:
`unlistToDataType()`	Function to flatten a list of output data and add names from the levels of the list
`unzipProject()`	Function for unzipping a zipped StoX project
`writeActiveProcessID()`	This function has the primary use of writing the proided activeProcessID to the activeProcessID.txt file
`writeProjectDescription()`	Write the project description.
`writeProjectDescriptionJSON()`	Write project description to a file in json format
`writeStoxJsonSchema()`	Export StoX JSON schema
`write_list_as_tables_NetCDFF4()`	Write/append a table/list of tables to NetCDF4

Reference

All functions