PAutilities (version 1.1.0)

paired_equivalence_wrapper: A template function for conducting a paired equivalence test

Description

A template function for conducting a paired equivalence test

Usage

paired_equivalence_wrapper(
  x,
  y,
  y_type,
  width,
  epsilon,
  alpha,
  scale,
  na.rm,
  do_test = TRUE
)

Arguments

x

numeric vector representing the (possibly surrogate) sample

y

numeric vector representing the (possibly criterion) sample. Index paired with x

y_type

classification of y for the purpose of analysis. Can be "criterion", "comparison", or "both".

width

the user-specified width of the equivalence region, possibly a proportion of an initially-uncalculated mean

epsilon

the calculated width of the equivalence region

alpha

the alpha level for the test

scale

character specifying whether the test should occur on an absolute or relative scale. Must be one of "relative" (default) or "absolute".

na.rm

logical. Omit mean values for mean calculations?

do_test

logical. Complete the test? Enables premature return that is useful in some cases