sta_wilcox: Wilcoxon Rank Sum and Signed Rank Tests

In j3ypi/inductive: A pipe-friendly and consistent framework for frequentist statistics in R

Description

Performs one- and two-sample Wilcoxon tests on vectors of data; the latter is also known as ‘Mann-Whitney’ test.

Usage

sta_wilcox(
  data = NULL,
  formula = NULL,
  x = NULL,
  y = NULL,
  alternative = c("two.sided", "less", "greater"),
  mu = 0,
  paired = FALSE,
  exact = NULL,
  correct = TRUE,
  conf.int = FALSE,
  conf.level = 0.95,
  obj = TRUE,
  na.action = getOption("na.action"),
  ...
)

Arguments

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).
formula	a formula of the form lhs ~ rhs where lhs is a numeric variable giving the data values and rhs a factor with two levels giving the corresponding groups.
x	numeric vector of data values. Non-finite (e.g., infinite or missing) values will be omitted.
y	an optional numeric vector of data values: as with x non-finite values will be omitted.
alternative	a character string specifying the alternative hypothesis, must be one of "two.sided" (default), "greater" or "less". You can specify just the initial letter.
mu	a number specifying an optional parameter used to form the null hypothesis. See ‘Details’.
paired	a logical indicating whether you want a paired test.
exact	a logical indicating whether an exact p-value should be computed.
correct	a logical indicating whether to apply continuity correction in the normal approximation for the p-value.
conf.int	a logical indicating whether a confidence interval should be computed.
conf.level	confidence level of the interval.
obj	a logical whether the test object of stats::t.test() should be returned.
na.action	a function which indicates what should happen when the data contain NAs. Defaults to getOption("na.action").
...	further arguments to be passed to or from methods.

Examples

## Not run: 
library(magrittr)
data(big_five, package = "inductive")

res <- big_five %>%
  sta_wilcox(Extraversion ~ Geschlecht)

res$result
res$obj

big_five %>%
  sta_wilcox(Extraversion ~ Neurotizismus)

big_five %>%
  sta_wilcox(x = Extraversion, y = Neurotizismus)

big_five %>%
  sta_wilcox(x = Neurotizismus, y = Extraversion)

## End(Not run)

j3ypi/inductive documentation built on Feb. 7, 2020, 12:37 p.m.