describe_marssMODEL: Describe a marssMODEL Objects

describe.marssMODELR Documentation

Describe a marssMODEL Objects

Description

describe.marssMODEL will print out information on the model in short form (e.g. 'diagonal and equal'). It is used by print(). It calls form specific functions: describe_dfa, describe_marss, and describe_marxss.

Usage

describe.marssMODEL(x)

Arguments

x

A marssMODEL object.

Value

describe.marssMODEL(marssMODEL) returns a list with the structure of each parameter matrix in 'English' (e.g. 'diagonal and unequal').

Author(s)

Eli Holmes, NOAA, Seattle, USA.

Examples

 
dat <- t(harborSeal)
dat <- dat[c(2, 11), ]
MLEobj <- MARSS(dat)

MARSS:::describe.marssMODEL(MLEobj$model)

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