pairwiseComparisons (version 3.2.0)

pairwise_caption: Pairwise comparison test expression

Description

This returns an expression containing details about the pairwise comparison test and the p-value adjustment method. These details are typically included in the ggstatsplot package plots as a caption.

Usage

pairwise_caption(
  caption,
  test.description,
  pairwise.display = "significant",
  ...
)

Arguments

caption

Additional text to be included in the plot.

test.description

Text describing the details of the test.

pairwise.display

Decides which pairwise comparisons to display. Available options are:

• "significant" (abbreviation accepted: "s")

• "non-significant" (abbreviation accepted: "ns")

• "all"

You can use this argument to make sure that your plot is not uber-cluttered when you have multiple groups being compared and scores of pairwise comparisons being displayed.

...

Ignored.

Examples

# NOT RUN {
library(pairwiseComparisons)
pairwise_caption("my caption", "Student's t-test")
# }