Repository files navigation

apathe is an R package that facilitates writing computationallyreproducible student theses that conform to the American PsychologicalAssociation (APA) manuscript guidelines (6th Edition). The packageprovides anR Markdown template thatcan be used with (or without)RStudio to create PDFdocuments (using theapa6 LaTeX class).apathe is built on top of the packagepapaja but is tailored to thespecific requirements of student theses and omits some features forsimplicity.

If you believe you have found a bug or would like to request a newfeature,open an issue onGithub and provide aminimal complete verifiableexample.

To useapathe you need either a recent version ofRStudio orpandoc. Youadditionally need aTeXdistribution; we recommend you useTinyTex, which can be installed fromwithin R:

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

Using other TeX distributions is possible. Please refer to thepapajamanualfor detailed installation instructions.

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

# Install remotes package if necessaryif(!requireNamespace("remotes",quietly=TRUE)) install.packages("remotes")# Install the stable development version from GitHubremotes::install_github("crsh/apathe")

Onceapathe is installed, you can select the APA-style thesistemplate when creating a new R Markdown file through the RStudio menus.

To add citations, specify your bibliography-file in the YAML frontmatter of the document (bibliography: my.bib) and start citing (fordetails, see pandoc manual on theciteprocextension).apathe supports DOI-based citations via thedoi2citefilter, seermdfiltrvignette.Any of the follow DOI tags can be used in the text:

• @https://doi.org/
• @doi.org/
• @DOI:
• @doi:

For example,@doi:10.1080/01621459.2025.2516210. When the document isrendered,doi2cite queries CrossRef for the bibliographic information,writes it to a local BibTeX-file and replaces the citation key by theproper BibTeX key.

This requires that the designated file__from_DOI.bib (it currentlyhas to be this file name!) is added to thebibliography field of theYAML front matter

Please citeapathe if you use it.

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

For convenience, you canusecite_r()or copy the reference information returned bycitation('apathe') toyour BibTeX file:

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

Likeapathe and want to contribute? We highly appreciate anycontributions to the R package or its documentation. Take a look at theopen issues if you needinspiration.

Please note that theapathe project is released with aContributorCode ofConduct.By contributing to this project, you agree to abide by its terms.