R/RstoxFramework-package.R

Defines functions .onLoad

#' The Engine of StoX
#'
#' The framwork of StoX >= 3.0.
#'
#' The RstoxFramework package is the engine of the stock assesment utility StoX, which is an open source application fo acoustic-trawl and swept-area survey estimation.
#'
#' The package creates an evironment containing the StoX project(s) in separate environments. Each StoX project consists of a list of data tables holding e.g. biotic and acoustic data, filtered versions of the data, strata system, definitios of primary sampling units, accompanied by a list of specifications of the StoX processes comprising the StoX project. A StoX process is an R function taking as input the project name, the input data and parameters used by the function.
#'
#' The package replaces the old Java library in StoX versions prior to StoX 4.0.
#' @docType package
#' @name RstoxFramework
#'
"_PACKAGE"

# Global variables
utils::globalVariables(c(
	 "..EDSUInfoToKeep", "..PSU", "..activeProcessID", "..digits", "..functionInputs",
	 "..functionName", "..functionParameters", "..haulInfoToKeep", "..idCol", "..newProcessName",
	 "..presentVariables", "..processDirty", "..propertyDirty", "..signifDigits", "..skipNAAt",
	 "..stationInfoToKeep", "..subsetByNAOn_New", "..subsetByNAOn_Old", "..toKeep", "..validInd",
	 "..x1x2y1y2", "AcoCat", "BeamKey", "BootstrapNetCDF4Data", "BootstrapSampleFactor",
	 "CruiseKey", "Haul", "Layer", "LogKey", "LogOrigin", "LogOrigin2", "PSU", "PolygonKey",
	 "ProcessName", "ResampleFunction", "SampleUnit", "Station", "StationWeight", "StoX", "Stratum",
	 "TableName", "WeightingFactor", "assignmentPasted", "canShowInMap", "capture.output", "ch",
	 "freq", "functionInputError", "functionName", "functionOutputDataType", "hasProcessData",
	 "lenght", "modelName", "name", "numStations", "offset", "possibleValues", "processID",
	 "processIndex", "processName", "projectPath", "resampledCountWithUniqueName", "st_linestring",
	 "st_sf", "st_sfc", "start_time", "transceiver", "value", "verbose", "weightsPasted"))

.onLoad <- function(libname, pkgname) {
	# Initiate the RstoxFramework environment:
	initiateRstoxFramework()
} 

# Packages to import to NAMESPACE (typically packages which are used extensively or packcages with special syntax that requires import, e.g, data.table)
#' @import data.table
NULL
StoXProject/RstoxFramework documentation built on Oct. 17, 2023, 1:24 p.m.