pairwise_caption: Expression containing details about pairwise comparison test

Description Usage Arguments Examples

View source: R/helpers.R

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

1
2
3
4
5
6
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") or "non-significant" (abbreviation accepted: "ns") or "everything"/"all". The default is "significant".

...

Ignored.

Examples

1
2
library(pairwiseComparisons)
pairwise_caption("my caption", "Student's t-test")

IndrajeetPatil/pairwiseComparisons documentation built on Oct. 20, 2020, 2:23 a.m.