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

Formatter functions in the 'apa' package take the return value of a
statistical test function, e.g. a call to chisq.test() and return a string
formatted according to the guidelines of the APA (American Psychological
Association).

Daniel Gromer

Format Outputs of Statistical Tests According to APA Guidelines

apa function

<dl><dt>x</dt>
<dd>An R object. Must be a call to one of <code>afex::aov_4</code>,
<code>afex::aov_car</code>, <code>afex::aov_ez</code>, <code>chisq.test</code>,
<code>cor.test</code>, <code>ez::ezANOVA</code> or <code>t_test</code>.</dd>
<dt>effect</dt>
<dd>(only applicable if <code>x</code> is an ANOVA) Character string
indicating the name of the effect to display. If is <code>NULL</code>, all
effects are reported (default).</dd>
<dt>format</dt>
<dd>Character string specifying the output format. One of
<code>"text"</code>, <code>"markdown"</code>, <code>"rmarkdown"</code>, <code>html</code>,
<code>"latex"</code> or <code>"docx"</code>.</dd>
<dt>print</dt>
<dd>Logical indicating whether to return the result as an R object
(<code>FALSE</code>) or print using <code>cat</code> (<code>TRUE</code>).</dd>
<dt>...</dt>
<dd>Further arguments passed to other methods</dd></dl>

Arguments

APA Formatting for RMarkdown Reports — apa

<dl>

<dt>x</dt>
<dd>An R object. Must be a call to one of <code>afex::aov_4</code>,
<code>afex::aov_car</code>, <code>afex::aov_ez</code>, <code>chisq.test</code>,
<code>cor.test</code>, <code>ez::ezANOVA</code> or <code>t_test</code>.</dd>


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


<dt>format</dt>
<dd>Character string specifying the output format. One of
<code>"text"</code>, <code>"markdown"</code>, <code>"rmarkdown"</code>, <code>html</code>,
<code>"latex"</code> or <code>"docx"</code>.</dd>


<dt>print</dt>
<dd>Logical indicating whether to return the result as an R object
(<code>FALSE</code>) or print using <code>cat</code> (<code>TRUE</code>).</dd>


<dt>...</dt>
<dd>Further arguments passed to other methods</dd>

</dl>

apa: APA Formatting for RMarkdown Reports

Description

Usage

Arguments

See Also