R/RstoxBase-package.R

Defines functions .onLoad

#' Base StoX Functions
#'
#' Base StoX functions used for survey estimation.
#'
#' The StoX functions defined in RstoxBase are those for defining resolution (e.g., PSUs and Layers), assignment, NASC data and StationLengthDistribution data, density, abundance and superindividual abundance
#' @docType package
#' @name RstoxBase
#'
"_PACKAGE"

# Global variables
utils::globalVariables(c(
	 ".", "..Cruise", "..DateTime", "..DensityType", "..Hauls", "..LengthDistributionType",
	 "..SpeciesCategoryCatchType", "..VerticalResolutionMax", "..VerticalResolutionMin",
	 "..WeightingFactors", "..acceptedColumns", "..atMissingLengthGroup", "..by", "..cols",
	 "..columnsToKeep", "..extract", "..extractFromDataCopy", "..haulGrouping",
	 "..horizontalResolution", "..keys", "..keysSansSample", "..lengthInterval",
	 "..lengthIntervalWidths", "..lengthVar", "..locatedStratum", "..meanBy", "..paddingVariables",
	 "..presentResolutionVariables", "..refvar", "..resolutionVar", "..sumBy", "..tomerge",
	 "..variablesToGetFromQuantityData", "..vars", "Abundance", "AcousticCategory",
	 "AcousticCategoryKey", "AcousticTargetStrength", "Area", "Beam", "BeamKey", "Biomass",
	 "CatchFractionNumber", "CatchFractionWeight", "Channel", "ChannelReferenceDepth",
	 "ChannelReferenceKey", "ChannelReferenceTilt", "ChannelReferenceType",
	 "ContainsAllSpeciesCategory", "ContainsAnySpeciesCategory", "Cruise", "CruiseKey",
	 "CruiseKey1", "DateTime", "Density", "DensityType", "DensityWeight", "Depth", "DepthExponent",
	 "EDSU", "EffectiveLogDistance", "EffectiveTowDistance", "EstimationMethod", "Haul", "HaulKey",
	 "ImputationMethod", "Individual", "IndividualIndex", "IndividualKey", "IndividualRoundWeight",
	 "IndividualTotalLength", "IndividualTotalLengthMiddle", "L1", "Latitude", "Layer",
	 "LengthDistributionType", "LengthExponent", "LengthResolution", "LogDuration", "LogKey",
	 "LogOrigin", "Longitude", "MaxChannelDepth", "MaxChannelRange", "MeanNASCWeight",
	 "MiddleDateTime", "MinChannelDepth", "MinChannelRange", "N", "NASCKey", "NASCWeight",
	 "NumberOfAssignedHauls", "PSU", "PSUByTime", "ReplaceIndividual", "ReplaceIndividualIndex",
	 "ReplaceLevel", "ReplaceStratumLayerIndividual", "ReplaceStratumLayerIndividualIndex", "SSU",
	 "SSUIndex", "SSULabel", "Sample", "SampleNumber", "SampleWeight", "SpeciesCategory",
	 "SpeciesCategoryCatchWeight", "SplitAcousticCategory", "StartDateTime", "Station",
	 "StationLevel", "StopDateTime", "Stratum", "StratumLayerIndividual",
	 "StratumLayerIndividualIndex", "StratumPolygon", "SummedWeights", "Survey", "SweepWidth",
	 "TargetStrength", "TargetStrength0", "TargetStrengthFunction",
	 "TempLengthGroupUsedInSuperIndividuals", "TotalLength", "V1", "WeightedNumber",
	 "WeightingFactor", "area", "area_hole", "assignmentID", "assignmentPasted",
	 "backscatteringCrossSection", "crossSection", "distance", "ggtitle", "haulWeightFactor",
	 "imputeSeed", "includeintotal", "individualNumber", "individualWeightFactor", "inside",
	 "insideRadius", "intervalIndex", "midIndividualTotalLength", "minDistance",
	 "missingAssignment", "missingSpecies", "numberOfIndividuals", "numberOfSubSamples",
	 "polygonAreaSP_simple", "raisingFactor", "representativeBackscatteringCrossSection",
	 "representativeBackscatteringCrossSectionNormalized", "setUnit", "sumArea",
	 "sumIndividualWeightFactor", "sumWeightedNumber", "temporary_denominator_column_name",
	 "temporary_numerator_column_name", "x", "y"))

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

# 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/RstoxBase documentation built on July 14, 2024, 9:39 a.m.