ReportRecaCatchAtAge: Report catch at age

In StoXProject/RstoxFDA: Fisheries Dependent Analysis with RstoX

Report catch at age

Description

Tabulates summary statistics for total catch (number) at age from MCMC simulations using Reca. MCMC simulations are typically obtained with RunRecaModels. Summary statistics are obtained from the posterior distribution, and the interval is reported as equal-tailed credible intervals.

If 'RecaCatchAtAge' contains estimate for a set of aggregation variables, such as area, gear, stock, etc., summary statistics will be presented similarly.

Rounding of numbers according to the argument 'Decimals' is done with round, so that negative numbers specify rounding to powers of ten, and rounding of the digit 5 is towards the even digit.

The units considered valid for catch at age in numbers are those listed for quantity 'cardinaltiy' in StoxUnits

Usage

ReportRecaCatchAtAge(
  RecaCatchAtAge,
  PlusGroup = integer(),
  IntervalWidth = numeric(),
  Decimals = integer(),
  Unit = RstoxData::getUnitOptions("cardinality", conversionRange = c(1, 1e+12))
)

Arguments

RecaCatchAtAge	Results from MCMC simulations (RecaCatchAtAge).
PlusGroup	If given, ages 'PlusGroup' or older are included in a plus group.
IntervalWidth	The width of the reported credible interval. A value of 0.9 gives 90 per cent credible intervals. Defaults to 0.9
Decimals	integer specifying the number of decimals to report for 'CatchAtAge', 'SD', 'Low' and 'High'. Defaults to 0.
Unit	unit for 'CatchAtAge', 'SD', 'Low' and 'High'

Value

ReportFdaCatchAtAgeData

See Also

RunRecaModels for running Reca-analysis and ReportRecaCatchAtLength for reporting length composition.

Examples

  catchAtAgeReport <- RstoxFDA::ReportRecaCatchAtAge(RstoxFDA::RecaCatchAtAgeExample, 
        PlusGroup = 13)
  catchAtAgeReport$NbyAge

StoXProject/RstoxFDA documentation built on Nov. 12, 2024, 3:42 a.m.