pairwiseComparisons (version 0.1.3)

pairwise_comparisons_caption: Preparing caption in case pairwise comparisons are displayed.

Description

Preparing caption in case pairwise comparisons are displayed.

Usage

pairwise_comparisons_caption(
  type,
  var.equal = FALSE,
  paired = FALSE,
  p.adjust.method = "holm",
  caption = NULL,
  ...
)
pairwise_p_caption(
  type,
  var.equal = FALSE,
  paired = FALSE,
  p.adjust.method = "holm",
  caption = NULL,
  ...
)

Arguments

type

Type of statistic expected ("parametric" or "nonparametric" or "robust" or "bayes").Corresponding abbreviations are also accepted: "p" (for parametric), "np" (nonparametric), "r" (robust), or "bf"resp.

var.equal

a logical variable indicating whether to treat the two variances as being equal. If TRUE then the pooled variance is used to estimate the variance otherwise the Welch (or Satterthwaite) approximation to the degrees of freedom is used.

paired

Logical that decides whether the experimental design is repeated measures/within-subjects or between-subjects. The default is FALSE.

p.adjust.method

Adjustment method for p-values for multiple comparisons. Possible methods are: "holm" (default), "hochberg", "hommel", "bonferroni", "BH", "BY", "fdr", "none".

caption

Text to display as caption (will be displayed on top of the description of pairwise comparison test).

...

Current ignored.

Value

An expression containing details about the pairwise comparison test carried out. These details are intended to be displayed in the caption of a plot.

Examples

# NOT RUN {
pairwiseComparisons::pairwise_comparisons_caption(
  type = "robust",
  paired = FALSE,
  p.adjust.method = "holm",
  caption = "this is caption"
)
# }