summary.estimate: Summary method for 'estimate.default' objects

In donaldRwilliams/BGGM: Bayesian Gaussian Graphical Models

Summary method for estimate.default objects

Description

Summarize the posterior distribution of each partial correlation with the posterior mean and standard deviation.

Usage

## S3 method for class 'estimate'
summary(object, col_names = TRUE, cred = 0.95, ...)

Arguments

object	An object of class estimate
col_names	Logical. Should the summary include the column names (default is TRUE)? Setting to FALSE includes the column numbers (e.g., 1--2).
cred	Numeric. The credible interval width for summarizing the posterior distributions (defaults to 0.95; must be between 0 and 1).
...	Currently ignored.

Value

A dataframe containing the summarized posterior distributions.

See Also

estimate

Examples

# data
Y <- ptsd[,1:5]

fit <- estimate(Y, iter = 250,
                progress = FALSE)

summary(fit)

donaldRwilliams/BGGM documentation built on April 17, 2024, 5:52 p.m.