t_out: Format t-Test Output

In mc-schaaf/rainR: Really Awesome and Interesting New R-Package

Format t-Test Output

Description

Distilles the most relevant data from an output object of t.test and displays the results in a compact format. Wrapper to t_out, but includes absolute differences.

Usage

t_out(
  toutput,
  n.equal = TRUE,
  welch.df.exact = TRUE,
  welch.n = NA,
  d.corr = FALSE,
  print = TRUE,
  abs.diff = NULL
)

Arguments

toutput	Output object created by a call to t.test.
n.equal	Only applicable to two-sample t-tests. If sample sizes are not equal, n.equal specifies a vector of sample sizes, e.g., n.equal = c(12,8).
welch.df.exact	Only applicable to Welch-tests. Indicates whether Welch-adjusted or unadjusted degrees of freedom (dfs) are reported (default=TRUE, i.e., Welch-adjusted dfs). If set to FALSE, the parameter welch.n has to be set as well.
welch.n	Only applicable to Welch-tests with unadjusted degrees of freedom. Parameter should be equal to the total sample size n=n_1+n_2.
d.corr	Only applicable to one-sample or paired-samples t-tests. If TRUE, Cohen's ds are computed using sqrt(2)-correction. Default changed to FALSE from version 1.5 onwards with an additional feedback message showing the use of corrections.
print	Force results to be displayed, even if the function output is assigned to a variable (e.g., output <- t_out(...); logical; default=TRUE).
abs.diff	Specifies the decimal places the absolute difference should be rounded to. If NULL, does not display absolute differences (APA 7th Standard).

Details

The output of a call to t_out is formatted according to the guidelines of the APA (American Psychological Association) as well as the DGPs ("Deutsche Gesellschaft fuer Psychologie"; German Psychological Society).

Value

returns a list containing (1) a description of the t-test (two-sample t-test, Welch-test, paired-samples t-test, one-sample t-test) and (2) a line with formatted results.

mc-schaaf/rainR documentation built on July 19, 2023, 5:09 p.m.