coef_marssMLE: Coefficient function for MARSS MLE objects

Description Usage Arguments Value Author(s) Examples

Description

The MARSS fitting function, MARSS, outputs marssMLE objects. coef(marssMLE), where marssMLE is one's output from a MARSS call, will print out the estimated parameters. The default output is a list with the estimated parameters for each MARSS parameter, however coef can be altered using the type argument to output a vector of all the estimated values (type="vector") or a list with the full parameter matrix with the estimated and fixed elements (type="matrix").

Usage

1
2
## S3 method for class 'marssMLE'
coef(object, ..., type="list", form=NULL, what="par")

Arguments

object

A marssMLE object.

...

Other arguments for coef.

type

What to print. Default is "list". If you input type as a vector, coef returns a list of output. See examples.

  • "list" A list of only the estimated values in each matrix. Each model matrix has it's own list element.

  • "vector" A vector of all the estimated values in each matrix.

  • "matrix" Returns the parameter matrix for that parameter with fixed values at their fixed values and the estimated values at their estimated values.

form

By default, coef uses the model form specified in the call to MARSS to determine how to display the coefficients. This information is in attr(marssMLE$model,"form") , however you can specify a different form. form="marss" should always work since this is the base model form in which the model objects are stored (in marssMLE$marss). This is mainly useful is you want to see your model transformed into marss form as seeing this can be helpful for debugging numerical problems.

what

By default, coef shows the parameter estimates. Other options are "par.se", "par.lowCI", "par.upCI", "par.bias", and "start".

Value

A list of the estimated parameters for each model matrix.

Author(s)

Eli Holmes, NOAA, Seattle, USA.

eli(dot)holmes(at)noaa(dot)gov

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
 
  dat = t(harborSeal)
  dat = dat[c(2,11),]
  MLEobj = MARSS(dat)
  
  coef(MLEobj)
  coef(MLEobj,type="vector")
  coef(MLEobj,type="matrix")
  #to retrieve just the Q matrix
  coef(MLEobj,type="matrix")$Q

gragusa/MARSS documentation built on May 17, 2019, 8:18 a.m.