rmarkdown: context_document – R documentation

Pricing

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

Get Started for Free

Documentation

rmarkdown

context_document

Convert to a ConTeXt document

Description

Format for converting from R Markdown to PDF using ConTeXt.

Usage

context_document(
  toc = FALSE,
  toc_depth = 2,
  number_sections = FALSE,
  fig_width = 6.5,
  fig_height = 4.5,
  fig_crop = "auto",
  fig_caption = TRUE,
  dev = "pdf",
  df_print = "default",
  template = NULL,
  keep_tex = FALSE,
  keep_md = FALSE,
  citation_package = c("default", "natbib", "biblatex"),
  includes = NULL,
  md_extensions = NULL,
  output_extensions = NULL,
  pandoc_args = NULL,
  context_path = NULL,
  context_args = NULL,
  ext = c(".pdf", ".tex")
)

Arguments

`toc`	`TRUE` to include a table of contents in the output
`toc_depth`	Depth of headers to include in table of contents
`number_sections`	`TRUE` to number section headings
`fig_width`	Default width (in inches) for figures
`fig_height`	Default height (in inches) for figures
`fig_crop`	Whether to crop PDF figures with the command `pdfcrop`. This requires the tools `pdfcrop` and `ghostscript` to be installed. By default, `fig_crop = TRUE` if these two tools are available.
`fig_caption`	`TRUE` to render figures with captions
`dev`	Graphics device to use for figure output (defaults to pdf)
`df_print`	Method to be used for printing data frames. Valid values include "default", "kable", "tibble", and "paged". The "default" method uses a corresponding S3 method of `print`, typically `print.data.frame`. The "kable" method uses the `knitr::kable` function. The "tibble" method uses the tibble package to print a summary of the data frame. The "paged" method creates a paginated HTML table (note that this method is only valid for formats that produce HTML). In addition to the named methods you can also pass an arbitrary function to be used for printing data frames. You can disable the `df_print` behavior entirely by setting the option `rmarkdown.df_print` to `FALSE`. See Data frame printing section in bookdown book for examples.
`template`	Pandoc template to use for rendering. Pass "default" to use the rmarkdown package default template; pass `NULL` to use pandoc's built-in template; pass a path to use a custom template that you've created. See the documentation on pandoc online documentation for details on creating custom templates.
`keep_tex`	Keep the intermediate tex file used in the conversion to PDF
`keep_md`	Keep the markdown file generated by knitting.
`citation_package`	The LaTeX package to process citations, `natbib` or `biblatex`. Use `default` if neither package is to be used, which means citations will be processed via the command `pandoc-citeproc`.
`includes`	Named list of additional content to include within the document (typically created using the `includes` function).
`md_extensions`	Markdown extensions to be added or removed from the default definition or R Markdown. See the `rmarkdown_format` for additional details.
`output_extensions`	Pandoc extensions to be added or removed from the output format, e.g., `"-smart"` means the output format will be `latex-smart`.
`pandoc_args`	Additional command line options to pass to pandoc
`context_path`	Path of the ConTeXt executable. If not provided, ConTeXt has to be available from the `PATH` environment variable.
`context_args`	Command line arguments passed to ConTeXt.
`ext`	Format of the output document (defaults to ".pdf").

Details

ConTeXt needs to be installed. To install the most recent version, see https://wiki.contextgarden.net/Installation. A less recent version is also available in TeX Live, you can install it with tinytex::tlmgr_install("context").

R Markdown documents can have optional metadata that is used to generate a document header that includes the title, author, and date. For more details see the documentation on R Markdown metadata.

R Markdown documents also support citations. You can find more information on the markdown syntax for citations in the Bibliographies and Citations article in the online documentation.

Value

R Markdown output format to pass to render.

Examples

## Not run: 
library(rmarkdown)

# simple invocation
render("input.Rmd", context_document())

## End(Not run)

rmarkdown

Dynamic Documents for R

v2.10

GPL-3

Authors

JJ Allaire [aut], Yihui Xie [aut, cre] (<https://orcid.org/0000-0003-0645-5666>), Jonathan McPherson [aut], Javier Luraschi [aut], Kevin Ushey [aut], Aron Atkins [aut], Hadley Wickham [aut], Joe Cheng [aut], Winston Chang [aut], Richard Iannone [aut] (<https://orcid.org/0000-0003-3925-190X>), Andrew Dunning [ctb] (<https://orcid.org/0000-0003-0464-5036>), Atsushi Yasumoto [ctb, cph] (<https://orcid.org/0000-0002-8335-495X>, Number sections Lua filter), Barret Schloerke [ctb], Carson Sievert [ctb] (<https://orcid.org/0000-0002-4958-2844>), Christophe Dervieux [ctb], Devon Ryan [ctb] (<https://orcid.org/0000-0002-8549-0971>), Frederik Aust [ctb] (<https://orcid.org/0000-0003-4900-788X>), Jeff Allen [ctb], JooYoung Seo [ctb] (<https://orcid.org/0000-0002-4064-6012>), Malcolm Barrett [ctb], Rob Hyndman [ctb], Romain Lesur [ctb], Roy Storey [ctb], Ruben Arslan [ctb], Sergio Oller [ctb], RStudio, PBC [cph], jQuery Foundation [cph] (jQuery library), jQuery contributors [ctb, cph] (jQuery library; authors listed in inst/rmd/h/jquery-AUTHORS.txt), jQuery UI contributors [ctb, cph] (jQuery UI library; authors listed in inst/rmd/h/jqueryui-AUTHORS.txt), Mark Otto [ctb] (Bootstrap library), Jacob Thornton [ctb] (Bootstrap library), Bootstrap contributors [ctb] (Bootstrap library), Twitter, Inc [cph] (Bootstrap library), Alexander Farkas [ctb, cph] (html5shiv library), Scott Jehl [ctb, cph] (Respond.js library), Ivan Sagalaev [ctb, cph] (highlight.js library), Greg Franko [ctb, cph] (tocify library), John MacFarlane [ctb, cph] (Pandoc templates), Google, Inc. [ctb, cph] (ioslides library), Dave Raggett [ctb] (slidy library), W3C [cph] (slidy library), Dave Gandy [ctb, cph] (Font-Awesome), Ben Sperry [ctb] (Ionicons), Drifty [cph] (Ionicons), Aidan Lister [ctb, cph] (jQuery StickyTabs), Benct Philip Jonsson [ctb, cph] (pagebreak Lua filter), Albert Krewinkel [ctb, cph] (pagebreak Lua filter)

Initial release

context_document

Description

Usage

Arguments

Details

Value

Examples

rmarkdown

We don't support your browser anymore