as.report: Create or test objects of class report.

In neuropsychology/report: Automated Reporting of Results and Statistical Models

Create or test objects of class report.

Description

Allows to create or test whether an object is of the report class.

Usage

as.report_text(x, ...)

as.report(text, table = NULL, plot = NULL, ...)

is.report(x)

as.report_effectsize(x, summary = NULL, prefix = "  - ", ...)

as.report_info(x, summary = NULL, ...)

as.report_intercept(x, summary = NULL, ...)

as.report_model(x, summary = NULL, ...)

as.report_parameters(x, summary = NULL, prefix = "  - ", ...)

as.report_performance(x, summary = NULL, ...)

as.report_priors(x, summary = NULL, ...)

as.report_random(x, summary = NULL, ...)

as.report_statistics(x, summary = NULL, prefix = "  - ", ...)

as.report_table(x, ...)

Arguments

x	An arbitrary R object.
...	Args to be saved as attributes.
text	Text obtained via report_text()
table	Table obtained via report_table()
plot	Plot obtained via report_plot(). Not yet implemented.
summary	Add a summary as attribute (to be extracted via summary()).
prefix	The prefix to be displayed in front of each parameter.

Value

A report object or a TRUE/FALSE value.

neuropsychology/report documentation built on April 3, 2024, 4:08 p.m.