uoc_psych_homework_pdf: University of Cologne Psychology Homework

View source: R/uoc_psych_homework_formats.R

uoc_psych_homework_pdfR Documentation

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

TRUE to render figures with captions

number_sections

TRUE to number section headings

toc

TRUE to include a table of contents in the output

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 options(tinytex.clean = FALSE).

md_extensions

Markdown extensions to be added or removed from the default definition of R Markdown. See the rmarkdown_format for additional details.

includes

Named list of additional content to include within the document (typically created using the includes function).

...

Further arguments to pass to pdf_document2 or word_document2.

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)

apathe documentation built on Oct. 19, 2026, 5:12 p.m.