report (version 0.1.0)

model_text: Text summary

Description

Create a reportable textual output for your model.

Usage

model_text(model, ...)
# S3 method for default
model_text(model, ...)
# S3 method for stanreg
model_text(model, ci_method = "hdi", ...)

Arguments

model

A statistical model.

...

Arguments passed to other methods, in particular model_parameters().

ci_method

The type of index used for Credible Interval. Can be "HDI" (default, see hdi), "ETI" (see eti) or "SI" (see si).

Value

A list with elements of class report_text (which are character vectors), containing a short and long version of the textual output of the model summary.

Examples

# NOT RUN {
model <- t.test(Sepal.Length ~ Species, data = iris[1:100, ])
model_text(model)
summary(model_text(model))
model <- lm(Sepal.Length ~ Petal.Length * Species, data = iris)
model_text(model)
summary(model_text(model))
# }