| Title: | American Psychological Association Thesis Templates for R Markdown |
| Version: | 0.1.0 |
| Date: | 2025-09-26 |
| Description: | Facilitates writing computationally reproducible student theses in PDF format that conform to the American Psychological Association (APA) manuscript guidelines (6th Edition). The package currently provides two R Markdown templates for homework and theses at the Psychology Department of the University of Cologne. The package builds on the package 'papaja' but is tailored to the requirements of student theses and omits features for simplicity. |
| URL: | https://github.com/crsh/apathe |
| BugReports: | https://github.com/crsh/apathe/issues |
| Imports: | papaja (≥ 0.1.3), bookdown, rmdfiltr (≥ 0.1.5), rmarkdown, assertthat |
| Suggests: | stringr, bibtex (≥ 0.5.1), testthat (≥ 3.0.0) |
| SystemRequirements: | Rendering the document template requires pandoc (>= 2.0; https://pandoc.org) and for PDFs a TeX distribution, such as TinyTeX (>= 0.12; https://yihui.org/tinytex/) |
| License: | MIT + file LICENSE |
| Encoding: | UTF-8 |
| Language: | en-US |
| RoxygenNote: | 7.3.3 |
| Config/testthat/edition: | 3 |
| NeedsCompilation: | no |
| Packaged: | 2025-10-07 09:00:33 UTC; frederikaust |
| Author: | Frederik Aust 
[aut, cre] |
| Maintainer: | Frederik Aust <frederik.aust@uni-koeln.de> |
| Repository: | CRAN |
| Date/Publication: | 2025-10-10 19:40:02 UTC |
University of Cologne Psychology Homework
Description
Template for homework in psychology at the University of Cologne in PDF format.
Usage
uoc_psych_homework_pdf(
fig_caption = TRUE,
number_sections = FALSE,
toc = FALSE,
keep_tex = FALSE,
md_extensions = NULL,
includes = NULL,
...
)
Arguments
fig_caption |
|
number_sections |
|
toc |
|
keep_tex |
Keep the intermediate tex file used in the conversion to PDF.
Note that this argument does not control whether to keep the auxiliary
files (e.g., ‘.aux’) generated by LaTeX when compiling ‘.tex’ to
‘.pdf’. To keep these files, you may set |
md_extensions |
Markdown extensions to be added or removed from the
default definition of R Markdown. See the
|
includes |
Named list of additional content to include within the
document (typically created using the |
... |
Further arguments to pass to
|
Details
When creating PDF documents the YAML option classoption is passed
to the class options of the LaTeX apa6 document class. In this case,
additional options are available. Refer to the apa6 document class
documentation
to find out about class options such as paper size.
Value
R Markdown output format to pass to rmarkdown::render().
See Also
uoc_psych_thesis_pdf, bookdown::pdf_document2(), bookdown::word_document2()
Examples
## Not run:
# Render skeleton
skeleton_path <- file.path(tempdir(), "homework_skeleton.Rmd")
rmarkdown::draft(
skeleton_path
, system.file(
"rmarkdown", "templates", "uoc-psych-homework"
, package = "apathe"
)
, create_dir = FALSE
, edit = FALSE
)
rmarkdown::render(skeleton_path, quiet = TRUE)
## End(Not run)
University of Cologne Psychology Thesis
Description
Template for theses in psychology at the University of Cologne in PDF format.
Usage
uoc_psych_thesis_pdf(
fig_caption = TRUE,
number_sections = FALSE,
keep_tex = TRUE,
md_extensions = NULL,
includes = NULL,
...
)
Arguments
fig_caption |
|
number_sections |
|
keep_tex |
Keep the intermediate tex file used in the conversion to PDF.
Note that this argument does not control whether to keep the auxiliary
files (e.g., ‘.aux’) generated by LaTeX when compiling ‘.tex’ to
‘.pdf’. To keep these files, you may set |
md_extensions |
Markdown extensions to be added or removed from the
default definition of R Markdown. See the
|
includes |
Named list of additional content to include within the
document (typically created using the |
... |
Further arguments to pass to
|
Details
This document template includes by default the logo of the University of Cologne, which is protected by copyright. We have explicit permission to distribute the logo with this template, but unauthorized use of the logo is restricted to "students for work and presentations in the context of their studies" or "cases where the University of Cologne acts as an organizer or originator":
"The use of the university seal is permitted in cases where the University of Cologne acts as an organizer or originator. This regulation includes the use of the university seal by students for work and presentations in the context of their studies.
The use of the university seal by natural or legal persons outside the University of Cologne requires written permission and is only possible in cases where there is a sufficient connection to the University of Cologne. If permission is to be granted for advertising purposes, the interests of the University of Cologne must be given special consideration. The purpose, type, and extent of the permitted use must be specified in the permission. The permission must be in written form."
You can use a different logo by setting the YAML option logo to the
path of the logo file. The logo should be a PDF file.
logo: file: "path/to/file.pdf" scale: 0.5
When creating PDF documents the YAML option classoption is passed
to the class options of the LaTeX apa6 document class. In this case,
additional options are available. Refer to the apa6 document class
documentation
to find out about class options such as paper size.
Value
R Markdown output format to pass to rmarkdown::render().
See Also
uoc_psych_homework_pdf, bookdown::pdf_document2(), bookdown::word_document2()
Examples
## Not run:
# Render skeleton
skeleton_path <- file.path(tempdir(), "thesis_skeleton.Rmd")
rmarkdown::draft(
skeleton_path
, system.file(
"rmarkdown", "templates", "uoc-psych-thesis"
, package = "apathe"
)
, create_dir = FALSE
, edit = FALSE
)
rmarkdown::render(skeleton_path, quiet = TRUE)
## End(Not run)