boral (version 2.0.2)

summary.boral: Summary of fitted boral object

Description

lifecycle::badge("stable")

A summary of the fitted boral objects including the type of model fitted e.g., error distribution, number of latent variables parameter estimates, and so on.

Usage

# S3 method for boral
summary(object, est = "median", ...)
# S3 method for summary.boral
print(x,...)

Value

Attributes of the model fitted, parameter estimates, and posterior probabilities of including individual and/or grouped coefficients in the model based on SSVS if appropriate.

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.

Author

tools:::Rd_package_author("boral")

Maintainer: tools:::Rd_package_maintainer("boral")

See Also

boral for the fitting function on which summary is applied.

Examples

if (FALSE) {
## NOTE: The values below MUST NOT be used in a real application;
## they are only used here to make the examples run quick!!!
example_mcmc_control <- list(n.burnin = 10, n.iteration = 100, 
    n.thin = 1)

testpath <- file.path(tempdir(), "jagsboralmodel.txt")


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

spiderfit_nb <- boral(y, family = "negative.binomial", 
     lv.control = list(num.lv = 2), row.eff = "fixed", 
     mcmc.control = example_mcmc_control, model.name = testpath)

summary(spiderfit_nb)
}