dataTOSTr: TOST Correlation

In TOSTER: Two One-Sided Tests (TOST) Equivalence Testing

TOST Correlation

Description

TOST for correlations in jamovi. This function is not meant to be utilized in R.

Usage

dataTOSTr(
  data,
  pairs,
  cor_type = "pearson",
  hypothesis = "EQU",
  low_eqbound_r = -0.3,
  high_eqbound_r = 0.3,
  alpha = 0.05,
  desc = FALSE,
  plots = FALSE
)

Arguments

data	the data as a data frame
pairs	a list of vectors of strings naming variables to correlate from data
cor_type	a character string indicating which correlation coefficient is to be used for the test. One of "pearson", "kendall", or "spearman", can be abbreviated.
hypothesis	'EQU' for equivalence (default), or 'MET' for minimal effects test, the alternative hypothesis.
low_eqbound_r	lower equivalence bounds (e.g., -0.3) expressed in a correlation effect size
high_eqbound_r	upper equivalence bounds (e.g., 0.3) expressed in a correlation effect size
alpha	alpha level (default = 0.05)
desc	TRUE or FALSE (default), provide descriptive statistics
plots	TRUE or FALSE (default), provide plots

Value

A results object containing:

results$text					a preformatted
results$tost					a table
results$desc					a table
results$plots					an array of images

Tables can be converted to data frames with asDF or as.data.frame. For example:

results$tost$asDF

as.data.frame(results$tost)

TOSTER documentation built on May 29, 2024, 9:57 a.m.