PAutilities (version 1.2.1)

new_paired_equivalence: A combined constructor and validator for paired_equivalence objects

Description

A combined constructor and validator for paired_equivalence objects

Usage

new_paired_equivalence(
  x,
  y,
  y_type = c("both", "criterion", "comparison"),
  alpha = 0.05,
  na.rm = TRUE,
  scale = c("relative", "absolute"),
  absolute_region_width = NULL,
  relative_region_width = NULL
)

Value

an initialized paired_equivalence object

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".

alpha

the alpha level for the test

na.rm

logical. Omit mean values for mean calculations?

scale

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

absolute_region_width

the region width for use when scale = "absolute"

relative_region_width

the region width for use when scale = "relative"