calcFC: Calculate a forecast from a single statistical model

Description Usage Arguments

View source: R/Module_calcFC.R

Description

Calculate a forecast from a single statistical model

Usage

1
2
3
4
5
6
7
8
9
calcFC(
  fit.obj = NULL,
  data = NULL,
  fc.yr = NULL,
  settings = NULL,
  tracing = FALSE,
  predictors = NULL,
  covariates = NULL
)

Arguments

fit.obj

A list, created by fitModel, with model fitting details for each age class.

data

A list. Equal to the element named data from output of prepData.

fc.yr

An integer of length one. The forecast year. If NULL (the default), then calculate as the year after the last run year in the data set.

settings

A list. The model-specific list of settings used in fitModel.

tracing

A Boolean. Default is FALSE

predictors

A list. Optional input needed for return rate model. Equal to the element named predictors from output of prepData. Default is NULL.

covariates

A list. Optional input needed for covariate model. Equal to the element named covariates from output of prepData. Default is NULL.


MichaelFolkes/forecastR_package documentation built on April 4, 2021, 5:14 a.m.