Describe a marssMODEL Objects

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

Eli Holmes, NOAA, Seattle, USA.

Examples

dat <- t(harborSeal)
dat <- dat[c(2, 11), ]
MLEobj <- MARSS(dat)
#> Success! abstol and log-log tests passed at 26 iterations.
#> Alert: conv.test.slope.tol is 0.5.
#> Test with smaller values (<0.1) to ensure convergence.
#> 
#> MARSS fit is
#> Estimation method: kem 
#> Convergence test: conv.test.slope.tol = 0.5, abstol = 0.001
#> Estimation converged in 26 iterations. 
#> Log-likelihood: 11.74016 
#> AIC: -9.480311   AICc: -6.3692   
#>  
#>                                           Estimate
#> R.diag                                      0.0115
#> U.X.CoastalEstuaries                        0.0613
#> U.X.OR.NorthCoast                           0.0510
#> Q.(X.CoastalEstuaries,X.CoastalEstuaries)   0.0147
#> Q.(X.OR.NorthCoast,X.OR.NorthCoast)         0.0122
#> x0.X.CoastalEstuaries                       7.3823
#> x0.X.OR.NorthCoast                          6.2707
#> Initial states (x0) defined at t=0
#> 
#> Standard errors have not been calculated. 
#> Use MARSSparamCIs to compute CIs and bias estimates.
#> 

MARSS:::describe.marssMODEL(MLEobj$model)
#> $Z
#> [1] "design matrix with rows: X.CoastalEstuaries X.OR.NorthCoast (2 x 2)"
#> 
#> $A
#> [1] "fixed and zero (2 x 1)"
#> 
#> $R
#> [1] "diagonal and equal (2 x 2)"
#> 
#> $B
#> [1] "identity (2 x 2)"
#> 
#> $U
#> [1] "unconstrained (2 x 1)"
#> 
#> $Q
#> [1] "diagonal and unequal (2 x 2)"
#> 
#> $x0
#> [1] "unconstrained (2 x 1)"
#> 
#> $V0
#> [1] "fixed and zero (2 x 2)"
#> 
#> $D
#> [1] "fixed and zero (2 x 1)"
#> 
#> $C
#> [1] "fixed and zero (2 x 1)"
#> 
#> $d
#> [1] "fixed and zero (1 x 1)"
#> 
#> $c
#> [1] "fixed and zero (1 x 1)"
#> 
#> $G
#> [1] "identity (2 x 2)"
#> 
#> $H
#> [1] "identity (2 x 2)"
#> 
#> $L
#> [1] "identity (2 x 2)"
#>