GearDependentCatchCompensation: Apply the sweep of different gear (and cruise)

In StoXProject/RstoxBase: Base StoX Functions

Apply the sweep of different gear (and cruise)

Description

This function multiplies the WeightedNumber of a LengthDistributionData by the sweep width given by CompensationTable. The result is a sweep width compensated length distribution (LengthDistributionType starting with "SweepWidthCompensated").

Usage

GearDependentCatchCompensation(
  InputDataType = c("LengthDistributionData", "SpeciesCategoryCatchData"),
  LengthDistributionData,
  SpeciesCategoryCatchData,
  CompensationMethod = c("Gear", "Cruise", "GearAndCruise"),
  CompensationTable = data.table::data.table(),
  keep.all = FALSE
)

Arguments

InputDataType	The datatype of the input, one of LengthDistributionData, SpeciesCategoryCatchData.
LengthDistributionData	The LengthDistributionData data.
SpeciesCategoryCatchData	The SpeciesCategoryCatchData data.
CompensationMethod	The method to use for the length dependent catch compensation, i.e. specifying which columns to provide the sweep width for.
CompensationTable	A table of the sweep width per combination of the variables specified in CompensationMethod. Note that all combinations present in the data must be given in the table, as the output should be sweep width compensated for all rows with non-missing WeightedNumber.
keep.all	Logical: If TRUE keep all columns, and if FALSE delete undefined columns.

StoXProject/RstoxBase documentation built on Nov. 6, 2024, noon