TOSTr: TOST function for a correlations

View source: R/TOSTr.R

TOSTrR Documentation

TOST function for a correlations

Description

[Superseded]

Development on TOSTr is complete, and for new code we recommend switching to corsum_test, which is easier to use, more featureful, and still under active development.

Usage

TOSTr(n, r, low_eqbound_r, high_eqbound_r, alpha, plot = TRUE, verbose = TRUE)

Arguments

n

number of pairs of observations

r

observed correlation

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)

plot

set whether results should be plotted (plot = TRUE) or not (plot = FALSE) - defaults to TRUE

verbose

logical variable indicating whether text output should be generated (verbose = TRUE) or not (verbose = FALSE) - default to TRUE

Value

Returns TOST p-value 1, TOST p-value 2, alpha, low equivalence bound r, high equivalence bound r, Lower limit confidence interval TOST, Upper limit confidence interval TOST

References

Goertzen, J. R., & Cribbie, R. A. (2010). Detecting a lack of association: An equivalence testing approach. British Journal of Mathematical and Statistical Psychology, 63(3), 527-537. https://doi.org/10.1348/000711009X475853, formula page 531.

Examples

TOSTr(n=100, r = 0.02, low_eqbound_r=-0.3, high_eqbound_r=0.3, alpha=0.05)

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