cor_out: Format Correlation Test Statistics

View source: R/cor_out.R

cor_outR Documentation

Format Correlation Test Statistics

Description

Distilles the most relevant data from an output object of cor.test and displays the results in a compact format.

Usage

cor_out(coroutput, stats = FALSE, print = TRUE, df = TRUE)

Arguments

coroutput

Output object created by a call to cor.test.

stats

If TRUE, the output includes t-values and corresponding degrees of freedom (default=FALSE.

print

Force results to be displayed, even if the function output is assigned to a variable (e.g., output <- cor_out(...); logical; default=TRUE).

df

Show degrees of freedom (df) rather than sample size (N) in parentheses after the Pearson correlation coefficient to match APA Style; logical; default=TRUE) as of schoRsch v1.11.

Details

The output of a call to cor.test 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

cor_out(coroutput,...) returns a line containing the formatted correlation results.

Author(s)

Markus Janczyk, Roland Pfister

See Also

cor; cor.test; anova_out; chi_out; t_out;


schoRsch documentation built on April 3, 2025, 6:11 p.m.

Related to cor_out in schoRsch...