Read and print the output from 'extended_summary'

extended_summary reads and prints the saved output from 'extended_summary'.

read_summary(path = ".", fill = "#6DCD59FF", highlight = FALSE)

Arguments

path: Directory in which to look for the 'extended_summary' output files.
fill: Color for posterior distribution fill. Default is "#6DCD59FF".
highlight: Logical to control if posterior estimates for which the 95% credible intervals do not overlap with zero are highlighted. Default is FALSE.

Value

If plot = TRUE the function reads the saved output of extended_summary and prints it.

Details

It prints a summary of brmsfit results that were previously saved by extended_summary. Useful when models are too big so reading them many times is to be avoided. It includes a model fit table, a coefficient table and a posterior distribution halfeye graph next to a chain trace plot. Tables are produce in html format so the output is nicely printed when knit in Rmarkdown files. You might have to add 'results = 'as.is', warning = FALSE and adjust fig.width to chunk options in Rmarkdown documents.

References

Araya-Salas (2022), brmsish: miscellaneous functions to customize brms bayesian regression models. R package version 1.0.0.Paul-Christian Buerkner (2017). brms: An R Package for Bayesian Multilevel Models Using Stan. Journal of Statistical Software, 80(1), 1-28. doi:10.18637/jss.v080.i01

Author

Marcelo Araya-Salas marcelo.araya@ucr.ac.cr)

Examples

{
# run model
md1 <- brm(Petal.Length ~ Petal.Width + Species, iris, chains = 1,
iter = 500)

# save summary
extended_summary(fit = md1, save = TRUE, dest.path = tempdir())

# read/print summary
read_summary(path = file.path(tempdir(), "md1"))
}
#> Compiling Stan program...
#> Error in .fun(model_code = .x1): Boost not found; call install.packages('BH')