apa6_pdf: APA manuscript (6th edition)

Description

Template for creating an article according to APA guidelines (6th edition) in PDF or DOCX format.

Usage

apa6_pdf(
  fig_caption = TRUE,
  number_sections = FALSE,
  toc = FALSE,
  keep_tex = TRUE,
  md_extensions = NULL,
  includes = NULL,
  ...
)
apa6_docx(
  fig_caption = TRUE,
  number_sections = FALSE,
  md_extensions = NULL,
  ...
)
apa6_word(...)
apa6_doc(...)

Value

R Markdown output format to pass to rmarkdown::render().

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.

Functions

apa6_word(): Format to create .docx-files. Alias of apa6_docx.
apa6_doc(): Format to create .docx-files. Alias of apa6_docx.

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 or draft watermarks.

Please refer to the papaja online-manual for additional information on available YAML front matter settings. Note that the available settings for DOCX documents are more limited than for PDF documents.