dataTOSTpaired: TOST Paired Samples T-Test

View source: R/datatostpaired.h.R

dataTOSTpairedR Documentation

TOST Paired Samples T-Test

Description

TOST Paired Samples T-Test in jamovi. This function is not meant to be utilized in R. See t_TOST function.

Usage

dataTOSTpaired(
  data,
  pair1,
  pair2,
  hypothesis = "EQU",
  low_eqbound = -0.5,
  high_eqbound = 0.5,
  eqbound_type = "raw",
  alpha = 0.05,
  desc = FALSE,
  plots = FALSE,
  low_eqbound_dz = -999999999,
  high_eqbound_dz = -999999999,
  indplot = FALSE,
  diffplot = FALSE,
  smd_type = "g"
)

Arguments

data

the data as a data frame

pair1

A string naming the first part of the pair

pair2

A string naming the second part of the pair

hypothesis

'EQU' for equivalence (default), or 'MET' for minimal effects test, the alternative hypothesis.

low_eqbound

a number (default: 0.5) the lower equivalence bounds

high_eqbound

a number (default: 0.5) the upper equivalence bounds

eqbound_type

'SMD' (default) or 'raw'; whether the bounds are specified in standardized mean difference (Cohen's dz) or raw units respectively

alpha

alpha level (default = 0.05)

desc

TRUE or FALSE (default), provide descriptive statistics

plots

TRUE or FALSE (default), provide plots

low_eqbound_dz

deprecated

high_eqbound_dz

deprecated

indplot

TRUE or FALSE (default), provide plot of paired data.

diffplot

TRUE or FALSE (default), provide plot of difference scores.

smd_type

'd' (default) or 'g'; whether the calculated effect size is biased (d) or bias-corrected (g).

Value

A results object containing:

results$text a html
results$tost a table
results$eqb a table
results$effsize a table
results$desc a table
results$plots an image
results$indplot an image
results$diffplot an image

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

results$tost$asDF

as.data.frame(results$tost)

References

Mara, C. A., & Cribbie, R. A. (2012). Paired-Samples Tests of Equivalence. Communications in Statistics - Simulation and Computation, 41(10), 1928-1943. formula page 1932. Note there is a typo in the formula: n-1 should be n (personal communication, 31-08-2016)

Examples

## Not run: 
library("TOSTER")

dataTOSTpaired(data = randu, pair1 = "x", pair2="y", low_eqbound = -0.3,
               high_eqbound = 0.3, alpha = 0.05, desc = TRUE, plots = TRUE)

## End(Not run)

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