report.brmsfit: Reporting Bayesian Models from brms

View source: R/report.brmsfit.R

report.brmsfitR Documentation

Reporting Bayesian Models from brms

Description

Create reports for Bayesian models. The description of the parameters follows the Sequential Effect eXistence and sIgnificance Testing framework (see SEXIT documentation).

Usage

## S3 method for class 'brmsfit'
report(x, ...)

Arguments

x

Object of class lm or glm.

...

Arguments passed to or from other methods.

Value

An object of class report().

See Also

Specific components of reports (especially for stats models):

  • report_table()

  • report_parameters()

  • report_statistics()

  • report_effectsize()

  • report_model()

  • report_priors()

  • report_random()

  • report_performance()

  • report_info()

  • report_text()

Other types of reports:

  • report_system()

  • report_packages()

  • report_participants()

  • report_sample()

  • report_date()

Methods:

  • as.report()

Template file for supporting new models:

  • report.default()

Examples



# Bayesian models
library(brms)
model <- suppressWarnings(brm(mpg ~ qsec + wt, data = mtcars, refresh = 0, iter = 300))
r <- report(model, verbose = FALSE)
r
summary(r)
as.data.frame(r)
summary(as.data.frame(r))



report documentation built on Sept. 11, 2024, 8:47 p.m.