report.test_performance: Reporting models comparison

In report: Automated Reporting of Results and Statistical Models

Reporting models comparison

Description

Create reports for model comparison as obtained by the performance::compare_performance() function in the performance package.

Usage

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

## S3 method for class 'test_performance'
report_table(x, ...)

## S3 method for class 'test_performance'
report_statistics(x, table = NULL, ...)

## S3 method for class 'test_performance'
report_parameters(x, table = NULL, ...)

## S3 method for class 'test_performance'
report_text(x, table = NULL, ...)

Arguments

x	Object of class ⁠NEW OBJECT⁠.
...	Arguments passed to or from other methods.
table	Provide the output of report_table() to avoid its re-computation.

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

library(report)
library(performance)

m1 <- lm(Sepal.Length ~ Petal.Length * Species, data = iris)
m2 <- lm(Sepal.Length ~ Petal.Length + Species, data = iris)
m3 <- lm(Sepal.Length ~ Petal.Length, data = iris)

x <- performance::test_performance(m1, m2, m3)
r <- report(x)
r
summary(r)
as.data.frame(r)
summary(as.data.frame(r))

# Specific reports
report_table(x)
report_statistics(x)
report_parameters(x)

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