report.htest: Reporting 'htest' objects (Correlation, t-test...)

In report: Automated Reporting of Results and Statistical Models

Reporting htest objects (Correlation, t-test...)

Description

Create reports for htest objects (t.test(), cor.test(), etc.).

Usage

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

## S3 method for class 'htest'
report_effectsize(x, ...)

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

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

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

## S3 method for class 'htest'
report_model(x, table = NULL, ...)

## S3 method for class 'htest'
report_info(x, effectsize = NULL, ...)

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

Arguments

x	Object of class htest.
...	Arguments passed to or from other methods.
table	Provide the output of report_table() to avoid its re-computation.
effectsize	Provide the output of report_effectsize() 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

# t-tests
report(t.test(iris$Sepal.Width, iris$Sepal.Length))
report(t.test(iris$Sepal.Width, iris$Sepal.Length, var.equal = TRUE))
report(t.test(mtcars$mpg ~ mtcars$vs))
report(t.test(mtcars$mpg, mtcars$vs, paired = TRUE), verbose = FALSE)
report(t.test(iris$Sepal.Width, mu = 1))

# Correlations
report(cor.test(iris$Sepal.Width, iris$Sepal.Length))

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