report.stanreg: Reporting Bayesian Models

View source: R/report.stanreg.R

report.stanregR Documentation

Reporting Bayesian Models

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 'stanreg'
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(rstanarm)
model <- suppressWarnings(stan_glm(mpg ~ qsec + wt, data = mtcars, refresh = 0, iter = 500))
r <- report(model)
r
summary(r)
as.data.frame(r)



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