Learn R Programming

boral (version 0.4)

summary.boral: Summary of fitted boral object

Description

A summary of the fitted boral objects including the type of model fitted e.g., error distribution, number of latent variables parameter estimates, values of the information criteria (if applicable), and so on.

Usage

## S3 method for class 'boral':
summary(object, est = "median", ...)

## S3 method for class 'summary.boral': print(x,...)

Arguments

object
An object of class "boral".
x
An object of class "boral".
est
A choice of either whether to print the posterior median (est == "median") or posterior mean (est == "mean") of the parameters.
...
Not used.

Value

  • Attributes of the model fitted, parameter estimates, and values of the information crtieria if calc.ics = TRUE in the boral object.

See Also

boral for the fitting function on which summary is applied, get.measures for details regarding the information criteria returned.

Examples

Run this code
library(mvabund) ## Load a dataset from the mvabund package
data(spider)
y <- spider$abun

spider.fit.nb <- boral(y, family = "negative.binomial", num.lv = 2, 
     site.eff = TRUE, save.model = FALSE, calc.ics = TRUE)

summary(spider.fit.nb)

Run the code above in your browser using DataLab