fitModel: General Model Fitting Functon

Description Usage Arguments Details Value

View source: R/Module_fitModel.R

Description

This function applies the estimation step for the various models. It sets up the data inputs (e.g. loop through age classes, ) and calls the estimation subroutine then stores the output in a list object. Model-specific sub-routines live in the file "Module_Sub_EstimationFunctions.R".

Usage

1
2
3
4
5
6
7
fitModel(
  model = c("Naive", "ReturnRate", "Mechanistic", "SibRegSimple", "SibRegKalman",
    "SibRegLogPower", "TimeSeriesArima", "TimeSeriesExpSmooth"),
  data = NULL,
  settings = NULL,
  tracing = FALSE
)

Arguments

model

A character vector of length one. The name of a model, it has to match one of the model names in the "estimation.functions" list objects. which is generated from the script R/Module_Sub_EstimationFunctions.R.

data

Same as the data element from the list object generated by prepData()

settings

A list. Model-specific list of settings, where applicable.

tracing

A Boolean. Default is FALSE.

Details

FOR NOW: JUST MAKING THIS WORK WITH THE BASIC SIBLING REGRESSION AND KALMAN FILTER SIBLING REGRESSION

Value

A list.


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