apa: APA Formatting for RMarkdown Reports

View source: R/apa.R

apaR Documentation

APA Formatting for RMarkdown Reports

Description

A wrapper around the *_apa functions, providing a convenient way to use the formatters in inline code in RMarkdown documents.

Usage

apa(x, effect = NULL, format = "rmarkdown", print = FALSE, ...)

Arguments

x

An R object. Must be a call to one of afex::aov_4, afex::aov_car, afex::aov_ez, chisq.test, cor.test, ez::ezANOVA or t_test.

effect

(only applicable if x is an ANOVA) Character string indicating the name of the effect to display. If is NULL, all effects are reported (default).

format

Character string specifying the output format. One of "text", "markdown", "rmarkdown", html, "latex" or "docx".

print

Logical indicating whether to return the result as an R object (FALSE) or print using cat (TRUE).

...

Further arguments passed to other methods

See Also

anova_apa, chisq_apa, cor_apa, t_apa


apa documentation built on Oct. 6, 2023, 5:08 p.m.