report (version 0.4.0)

report.default: Template to add report support for new objects

Description

Template file to add report support for new objects. Check-out the vignette on Supporting New Models.

Usage

# S3 method for default
report(x, ...)
# S3 method for default
report_effectsize(x, ...)
# S3 method for default
report_table(x, ...)
# S3 method for default
report_statistics(x, ...)
# S3 method for default
report_parameters(x, ...)
# S3 method for default
report_intercept(x, ...)
# S3 method for default
report_model(x, ...)
# S3 method for default
report_random(x, ...)
# S3 method for default
report_priors(x, ...)
# S3 method for default
report_performance(x, ...)
# S3 method for default
report_info(x, ...)
# S3 method for default
report_text(x, ...)

Arguments

x

Object of class NEW OBJECT.

...

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

# NOT RUN {
library(report)

# Add a reproducible example instead of the following
model <- lm(Sepal.Length ~ Petal.Length * Species, data = iris)
r <- report(model)
r
summary(r)
as.data.frame(r)
summary(as.data.frame(r))
# }