calcFC: Calculate a forecast from a single statistical model

In SalmonForecastR/ForecastR-Package: Forecast stuff

Calculate a forecast from a single statistical model

Description

Calculate a forecast from a single statistical model

Usage

calcFC(
  fit.obj = NULL,
  data = NULL,
  data.sibreg = 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.
data.sibreg	A data frame. Equal to the element named sibreg.in from output of prepData. NOTE: all the functions and subroutines should be rewritten to just use the full prepData output, but priority now is to get the new sibreg variations working
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. NOTE: This is now part of the list object created by fitModel, so should streamline the input.
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.

SalmonForecastR/ForecastR-Package documentation built on March 10, 2023, 2:18 p.m.