report.BFBayesFactor: Reporting 'BFBayesFactor' objects from the 'BayesFactor'...

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

Reporting BFBayesFactor objects from the BayesFactor package

Description

Interpretation of the Bayes factor output from the BayesFactor package.

Usage

## S3 method for class 'BFBayesFactor'
report(x, h0 = "H0", h1 = "H1", ...)

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

Arguments

x	An object of class BFBayesFactor.
h0, h1	Names of the null and alternative hypotheses.
...	Other arguments to be passed to effectsize::interpret_bf and insight::format_bf.
table	A parameters table (this argument is meant for internal use).

Examples

library(BayesFactor)

rez <- BayesFactor::ttestBF(iris$Sepal.Width, iris$Sepal.Length)
report_statistics(rez, exact = TRUE) # Print exact BF
report(rez, h0 = "the null hypothesis", h1 = "the alternative")

rez <- BayesFactor::correlationBF(iris$Sepal.Width, iris$Sepal.Length)
report(rez)

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