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.226   0.061   0.097   0.337
#>    B1--B3     0.058   0.059  -0.054   0.173
#>    B2--B3     0.505   0.053   0.392   0.601
#>    B1--B4     0.333   0.055   0.237   0.431
#>    B2--B4    -0.043   0.067  -0.165   0.096
#>    B3--B4     0.221   0.065   0.106   0.340
#>    B1--B5     0.146   0.067   0.012   0.278
#>    B2--B5     0.107   0.064  -0.032   0.230
#>    B3--B5     0.187   0.063   0.061   0.298
#>    B4--B5     0.341   0.058   0.235   0.459
#> --- 

# }