ses_calc: SES Calculation

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

SES Calculation

Description

Standardized effect size (SES), these are the effect sizes not considered SMDs.

Usage

ses_calc(x, ..., paired = FALSE, ses = "rb", alpha = 0.05)

## Default S3 method:
ses_calc(
  x,
  y = NULL,
  paired = FALSE,
  ses = c("rb", "odds", "cstat"),
  alpha = 0.05,
  mu = 0,
  ...
)

## S3 method for class 'formula'
ses_calc(formula, data, subset, na.action, ...)

Arguments

x	a (non-empty) numeric vector of data values.
...	further arguments to be passed to or from methods.
paired	a logical indicating whether you want to calculate a paired test.
ses	Standardized effect size. Default is "rb" for rank-biserial correlation. Options also include "cstat" for concordance probability, or "odds" for Wilcoxon-Mann-Whitney odds (otherwise known as Agresti's generalized odds ratio).
alpha	alpha level (default = 0.05)
y	an optional (non-empty) numeric vector of data values.
mu	number indicating the value around which (a-)symmetry (for one-sample or paired samples) or shift (for independent samples) is to be estimated. See stats::wilcox.test.
formula	a formula of the form lhs ~ rhs where lhs is a numeric variable giving the data values and rhs either 1 for a one-sample or paired test or a factor with two levels giving the corresponding groups. If lhs is of class "Pair" and rhs is 1, a paired test is done.
data	an optional matrix or data frame (or similar: see model.frame) containing the variables in the formula formula. By default the variables are taken from environment(formula).
subset	an optional vector specifying a subset of observations to be used.
na.action	a function which indicates what should happen when the data contain NAs. Defaults to getOption("na.action").

Details

For details on the calculations in this function see vignette("robustTOST").

Value

A data frame containing the standardized effect size.

See Also

Other effect sizes: smd_calc()

Examples

## Not run: 
ses_calc(formula = extra ~ group, data = sleep, paired = TRUE, ses = "r")

## End(Not run)

TOSTER documentation built on Sept. 15, 2023, 1:09 a.m.