apathe: American Psychological Association Thesis
with R Markdown

apathe is an R package that facilitates writing computationally reproducible student theses that conform to the American Psychological Association (APA) manuscript guidelines (6th Edition). The package provides an R Markdown template that can be used with (or without) RStudio to create PDF documents (using the apa6 LaTeX class). apathe is built on top of the package papaja but is tailored to the specific requirements of student theses and omits some features for simplicity.

If you believe you have found a bug or would like to request a new feature, open an issue on Github and provide a minimal complete verifiable example.

Example

TBD

Installation

To use apathe you need either a recent version of RStudio or pandoc. You additionally need a TeX distribution; we recommend you use TinyTex, which can be installed from within R:

if(!requireNamespace("tinytex", quietly = TRUE)) install.packages("tinytex")

tinytex::install_tinytex()

Using other TeX distributions is possible. Please refer to the papaja manual for detailed installation instructions.

apathe is not yet available on CRAN but you can install it from this GitHub repository:

# Install remotes package if necessary
if(!requireNamespace("remotes", quietly = TRUE)) install.packages("remotes")

# Install the stable development version from GitHub
remotes::install_github("crsh/apathe")

Usage

Once apathe is installed, you can select the APA-style thesis template when creating a new R Markdown file through the RStudio menus.

APA template selection dialog

To add citations, specify your bibliography-file in the YAML front matter of the document (bibliography: my.bib) and start citing (for details, see pandoc manual on the citeproc extension. You may also be interested in citr, an R Studio addin to swiftly insert Markdown citations and R Studio’s visual editor, which also enables swiftly inserting citations.

Reporting analysis results

papaja provides

• Functions to typeset the results from statistical analyses,
• functions to create tables, and
• functions to create figures in accordance with APA guidelines.

For a comprehensive introduction to papaja, see the README or the current draft of the manual.

Citation

Please cite apathe if you use it.

Aust, F. (2024). apathe: American Psychological Association Thesis with R Markdown. R package version 0.0.0.9000. Retrieved from https://github.com/crsh/apathe

For convenience, you can use cite_r() or copy the reference information returned by citation('apathe') to your BibTeX file:

@Manual{,
  title = {{apathe}: {American} American Psychological Association Thesis with {R Markdown}},
  author = {Frederik Aust},
  year = {2024},
  note = {R package version 0.0.0.9000},
  url = {https://github.com/crsh/apathe},
}

Contribute

Like apathe and want to contribute? We highly appreciate any contributions to the R package or its documentation. Take a look at the open issues if you need inspiration.

Code of Conduct

Please note that the apathe project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

Package dependencies