tidy.marssMLER Documentation

Return estimated parameters with summary information

Description

tidy.marssMLE returns the parameter estimates and their confidence intervals.

The tidy function is designed to work with the broom package and you will need to load that package if you want to call tidy(fit) instead of tidy.marssMLE(fit).

Usage

tidy.marssMLE(x, conf.int = TRUE, conf.level = 0.95, ...)

Arguments

x

a marssMLE object

conf.int

Whether to compute confidence and prediction intervals on the estimates.

conf.level

Confidence level. alpha=1-conf.level

...

Optional arguments. If conf.int=TRUE, then arguments to specify how CIs are computed can be passed in. See details and MARSSparamCIs.

Details

tidy.marssMLE() assembles information available via the print() and coef() functions into a data frame that summarizes the estimates. If conf.int=TRUE, MARSSparamCIs() will be run to add confidence intervals to the model object if these are not already added. The default CIs are calculated using a analytically computed Hessian matrix. This can be changed by passing in optional arguments for MARSSparamCIs().

Value

A data frame with estimates, sample standard errors, and confidence intervals.

Examples

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

# A data frame of the estimated parameters
tidy.marssMLE(fit)

# If broom is used

library(broom)
tidy(fit)