utility.functions {MARSS}R Documentation

Utility Functions

Description

Utility functions for MARSS functions in the MARSS-package. These are not exported but can be accessed using the MARSS::: prefix.

Usage

vector.all.equal(x)
convert.model.mat(param.matrix)
fixed.free.to.formula(fixed,free,dim)
fully.spec.x(Z, R)
Imat(x)
is.blockdiag(x)
is.design(x, strict=TRUE, dim=NULL, zero.rows.ok=FALSE, zero.cols.ok=FALSE)
is.diagonal(x, na.rm=FALSE)
is.equaltri(x)
is.fixed(x, by.row=FALSE)
is.identity(x, dim=NULL)
is.timevarying(MLEobj)
is.solvable(A,y=NULL)
is.validvarcov(x, method="kem")
is.wholenumber(x, tol = .Machine$double.eps^0.5)
is.unitcircle(x, tol = .Machine$double.eps^0.5)
is.zero(x)
makediag(x, nrow=NA)
marssMODEL.to.list(MODELobj)
matrix.power(x, n)
mystrsplit(x)
parmat(MLEobj, elem = c("B", "U", "Q", "Z", "A", "R", "x0", "V0", "G", "H", "L"), 
    t = 1, dims = NULL, model.loc = "marss")
pinv(x)
pcholinv(x, chol = TRUE)
pchol(x) 
rwishart(nu, V)
sub3D(x,t=1)
takediag(x)
unvec(x, dim=NULL)
vec(x)

Arguments

x, A, y

A matrix (or vector for 'makediag' or string for 'mystrsplit'.).

Z, R

Z matrix and R matrix

na.rm

How to treat NAs in the block diag test.

dim, dims

Matrix dimensions. Some functions will take the vec of a matrix. In this case, the optional dim arg specifies the matrix dimensions.

fixed

A fixed matrix per the MARSS specification for fixed matrix syntax.

free

A free matrix per the MARSS specification for free matrix syntax.

nrow

Number of rows.

tol

Tolerance.

method

kem or BFGS. Used to add extra test for MARSSoptim().

t

The time index or third dimension of a 3D matrix

nu, V

Parameters of a Wishart distribution.

param.matrix

The list matrix version of a time-invariant MARSS model.

n

An integer for the power function.

zero.rows.ok, zero.cols.ok

Means the design matrix can have all zero rows or columns.

strict

Specifies whether the design matrix must be only 0s and 1s.

by.row

For is.fixed, reports whether is.fixed by row rather than for the whole matrix.

chol

For pcholinv, use chol2inv(chol()) if TRUE otherwise use solve().

MLEobj

A marssMLE object.

MODELobj

A marssMODEL object.

elem

The parameter matrix of a marss model to return.

model.loc

Whether to use the marss or model marssMODEL in the marssMLE object.

Details

Value

See above.

Author(s)

Eli Holmes and Eric Ward, NOAA, Seattle, USA.


[Package MARSS version 3.11.9 Index]