report (version 0.1.0)

report: Automatic report of R objects

Description

Create reports of different objects. See the documentation for your object's class:

Usage

report(model, ...)

Arguments

model

A statistical model. For data frame or character methods, a data frame or character respectively.

...

Arguments passed to or from other methods.

Value

A list-object of class report, which contains further list-objects with a short and long description of the model summary, as well as a short and long table of parameters and fit indices.

Details

• Dataframes and vectors

• Correlations and t-tests (htest)

• ANOVAs

• Regression models (glm, lm, ...)

• Mixed models (glmer, lmer, glmmTMB, ...)

• Bayesian models (stanreg, brms...)

Change output type

The report() function generates a report-object that contain in itself different representations (e.g., text, tables, plots). These different representations can be accessed via several functions, such as:

• text_long(): Detailed text.

• text_short(): Minimal text giving the minimal information.

• table_long(): Comprehensive table including most available indices.

• table_short(): Minimal table.

Note that for some report objects, some of these representations might be identical.

See Also

table_short or text_short to access the related content of the report-object.

Examples

# NOT RUN {
library(report)

model <- t.test(Sepal.Length ~ Species, data = iris[1:100, ])
r <- report(model)

# Text
r
summary(r)

# Tables
as.data.frame(r)
summary(as.data.frame(r)) # equivalent to as.table(r)

# List
as.list(r)
# }