ReportSpeciesCategoryCatch: Report SpeciesCategoryCatch

View source: R/Report.R

ReportSpeciesCategoryCatchR Documentation

Report SpeciesCategoryCatch

Description

Reports the sum, mean or other functions on a variable of the SpeciesCategoryCatch.

Usage

ReportSpeciesCategoryCatch(
  SpeciesCategoryCatchData,
  TargetVariable = c("TotalCatchWeight", "TotalCatchNumber"),
  TargetVariableUnit = character()
)

Arguments

SpeciesCategoryCatchData

The SpeciesCategoryCatchData data.

TargetVariable

The column to report.

TargetVariableUnit

The unit to use for the TargetVariable. See RstoxData::StoxUnits for possible units (look for the appropriate quantity, e.g. "length" for IndividualTotalLength, and use the shortname in the TargetVariableUnit).

Details

This function is useful to, e.g, sum Biomass for each SpeciesCategory and IndividualTotalLenght, or average IndividualTotalLength for each IndiivdualAge and Stratum.

Value

A ReportSpeciesCategoryCatchData object.


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