Summary method for estimate.default objects

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

# \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.231   0.062   0.112   0.344
#>    B1--B3     0.052   0.069  -0.084   0.176
#>    B2--B3     0.501   0.054   0.383   0.601
#>    B1--B4     0.336   0.058   0.220   0.442
#>    B2--B4    -0.030   0.068  -0.161   0.101
#>    B3--B4     0.218   0.066   0.090   0.333
#>    B1--B5     0.151   0.069   0.025   0.282
#>    B2--B5     0.101   0.069  -0.039   0.231
#>    B3--B5     0.188   0.070   0.039   0.315
#>    B4--B5     0.336   0.056   0.232   0.440
#> --- 

# }