aov_wrapper: Format ANOVA results for APA reporting

View source: R/format_strings.R

aov_wrapperR Documentation

Format ANOVA results for APA reporting

Description

This function takes the outputs from an ANOVA object (the F-ratio, the degrees of freedom, the p-value, and, optionally, the partial eta squared) and formats them as a string for easy copying and pasting into a document or piping into a markdown script. To return a string that is not formatted for markdown, set as.markdown to FALSE. All arguments can be passed either as strings or as numbers.

Usage

aov_wrapper(f_stat, dfn, dfd, p_val, partial_eta = NA, as.markdown = TRUE)

Arguments

f_stat

The F ratio from an ANOVA

dfn

The degrees of freedom (numerator) from an ANOVA

dfd

The degrees of freedom (denominator) from an ANOVA

p_val

The p-value from an ANOVA

partial_eta

Optional, the effect size from an ANOVA. Default is NA

as.markdown

Return a string formatted for markdown output? Default is TRUE

Value

An APA-formatted string of the ANOVA results


silverer/statstring documentation built on Aug. 6, 2023, 11:48 a.m.