summary.rct3: Summarise an rct3 fit

In rct3: Predict Fish Year-Class Strength from Survey Data

Description

Print an rct3 fit showing the model settings, a summary of the prediction for each yearclass and the overall predicted recruitments

Usage

## S3 method for class 'rct3'
summary(object, digits = max(3, getOption("digits") - 3), ...)

Arguments

object	an object of class rct3 - an output from the rct3 function.
digits	optional integer for how much to round the values in the output tables.
...	additional arguments to print.data.frame

Value

invisibly returns a summary data frame.

See Also

rct3 run a calibrated regression to predict rectruitment.

rct3-package gives an overview of the package.

Examples

# load recruitment data
data(recdata)

formula <- recruitment ~ NT1 + NT2 + NT3 +
                         NAK1 + NAK2 + NAK3 +
                         RT1 + RT2 + RT3 +
                         EC01 + ECO2 + ECO3

my_rct3 <- rct3(formula, recdata, predictions = 2012:2017, shrink = TRUE)

# see a short summary
my_rct3

# for a full summary do:
summary(my_rct3)

# the components are here:
my_rct3$rct3
my_rct3$rct3.summary

# predicted recruitment
t(my_rct3$rct3.summary["WAP"])

rct3 documentation built on Oct. 23, 2020, 8:18 p.m.