toLatex_marssMLE: Create a LaTeX Version of the Model

In MARSS: Multivariate Autoregressive State-Space Modeling

Create a LaTeX Version of the Model

Description

Creates LaTex and a PDF (if LaTeX compiler available) using the tools in the Hmisc package. The files are saved in the working directory.

Usage

## S3 method for class 'marssMODEL'
toLatex(object, ..., file = NULL, digits = 2, greek = TRUE, orientation = "landscape", 
math.sty = "amsmath", output = c("pdf", "tex", "rawtex"), replace = TRUE, simplify = TRUE)
## S3 method for class 'marssMLE'
toLatex(object, ..., file = NULL, digits = 2, greek = TRUE, orientation = "landscape", 
math.sty = "amsmath", output = c("pdf", "tex", "rawtex"), replace = TRUE, simplify = TRUE)

Arguments

object	A marssMODEL or marssMLE object.
...	Other arguments. Not used.
file	Name of file to save to. Optional.
digits	Number of digits to display for numerical values (if real).
greek	Use greek symbols.
orientation	Orientation to use. landscape or portrait.
math.sty	LaTeX math styling to use.
output	pdf, tex or rawtex. If blank, both are output.
replace	Replace existing file if present.
simplify	If TRUE, then if \mathbf{B} or \mathbf{Z} are identity, they do not appear. Any zero-ed out elements also do not appear.

Value

A LaTeX and or PDF file of the model.

Author(s)

Eli Holmes, NOAA, Seattle, USA.

Examples

 
# Example with linear constraints
dat <- t(harborSeal)
dat <- dat[c(2:4), ]
Z1 <- matrix(list("1*z1+-1*z2",0,"z2","2*z1","z1",0),3,2)
A1 <- matrix(list("a1",0,0),3,1)
MLEobj <- MARSS(dat, model=list(Z=Z1, A=A1, Q=diag(0.01,2)))
 ## Not run: 
 toLatex(MLEobj)
 toLatex(MLEobj$model)
 
## End(Not run)

MARSS documentation built on May 31, 2023, 9:28 p.m.