checkModelList: Check model List Passed into MARSS Call

View source: R/checkModelList.r

checkModelListR Documentation

Check model List Passed into MARSS Call

Description

This is a helper function to check the model list passed in to a MARSS() call for any errors. Not exported.

Usage

checkModelList( model, defaults, this.form.allows)

Arguments

model

A list from which a marssMODEL model will be constructed.

defaults

A list with the defaults for the elements in the model list in case the user leaves out any.

this.form.allows

A list of what inputs are allowed for each element in the model list.

Details

This is a helper function to check that all the model list that will be passed to a MARSS.form function to make the marssMODEL object. If elements in the list are left off, they will be filled in by defaults.

Value

If the function does not stop due to errors, it returns an updated model list with missing elements filled in by the defaults.

Author(s)

Eli Holmes, NOAA, Seattle, USA.

See Also

MARSS(), marssMODEL, checkModelList


MARSS documentation built on May 29, 2024, 3:34 a.m.