Skip to contents

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

Examples

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

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

summary(fit)
#> BGGM: Bayesian Gaussian Graphical Models 
#> --- 
#> Type: continuous 
#> Analytic: FALSE 
#> Formula:  
#> Posterior Samples: 250 
#> Observations (n):
#> Nodes (p): 5 
#> Relations: 10 
#> --- 
#> Call: 
#> estimate(Y = Y, iter = 250, progress = FALSE)
#> --- 
#> Estimates:
#>  Relation Post.mean Post.sd Cred.lb Cred.ub
#>    B1--B2     0.233   0.067   0.100   0.360
#>    B1--B3     0.059   0.073  -0.083   0.186
#>    B2--B3     0.492   0.056   0.370   0.591
#>    B1--B4     0.331   0.062   0.204   0.438
#>    B2--B4    -0.030   0.067  -0.164   0.103
#>    B3--B4     0.221   0.064   0.103   0.355
#>    B1--B5     0.161   0.058   0.046   0.271
#>    B2--B5     0.104   0.067  -0.018   0.229
#>    B3--B5     0.182   0.072   0.058   0.326
#>    B4--B5     0.336   0.061   0.228   0.455
#> --- 

# }