Learn R Programming
rmarkdown (version 2.28)

rmarkdown-package: R Markdown Document Conversion

Description

Convert R Markdown documents into a variety of formats including HTML, MS Word, PDF, and Beamer.

Arguments

Author

Maintainer: Yihui Xie xie@yihui.name (ORCID)

Authors:

Other contributors:

  • Andrew Dunning (ORCID) [contributor]

  • Atsushi Yasumoto (ORCID) (Number sections Lua filter) [contributor, copyright holder]

  • Barret Schloerke [contributor]

  • Carson Sievert (ORCID) [contributor]

  • Devon Ryan dpryan79@gmail.com (ORCID) [contributor]

  • Frederik Aust frederik.aust@uni-koeln.de (ORCID) [contributor]

  • Jeff Allen jeff@posit.co [contributor]

  • JooYoung Seo (ORCID) [contributor]

  • Malcolm Barrett [contributor]

  • Rob Hyndman Rob.Hyndman@monash.edu [contributor]

  • Romain Lesur [contributor]

  • Roy Storey [contributor]

  • Ruben Arslan ruben.arslan@uni-goettingen.de [contributor]

  • Sergio Oller [contributor]

  • Posit Software, PBC [copyright holder, funder]

  • jQuery UI contributors (jQuery UI library; authors listed in inst/rmd/h/jqueryui/AUTHORS.txt) [contributor, copyright holder]

  • Mark Otto (Bootstrap library) [contributor]

  • Jacob Thornton (Bootstrap library) [contributor]

  • Bootstrap contributors (Bootstrap library) [contributor]

  • Twitter, Inc (Bootstrap library) [copyright holder]

  • Alexander Farkas (html5shiv library) [contributor, copyright holder]

  • Scott Jehl (Respond.js library) [contributor, copyright holder]

  • Ivan Sagalaev (highlight.js library) [contributor, copyright holder]

  • Greg Franko (tocify library) [contributor, copyright holder]

  • John MacFarlane (Pandoc templates) [contributor, copyright holder]

  • Google, Inc. (ioslides library) [contributor, copyright holder]

  • Dave Raggett (slidy library) [contributor]

  • W3C (slidy library) [copyright holder]

  • Dave Gandy (Font-Awesome) [contributor, copyright holder]

  • Ben Sperry (Ionicons) [contributor]

  • Drifty (Ionicons) [copyright holder]

  • Aidan Lister (jQuery StickyTabs) [contributor, copyright holder]

  • Benct Philip Jonsson (pagebreak Lua filter) [contributor, copyright holder]

  • Albert Krewinkel (pagebreak Lua filter) [contributor, copyright holder]

Details

The rmarkdown package includes high level functions for converting to a variety of formats. For example:


render("input.Rmd", html_document())
render("input.Rmd", pdf_document())

You can also specify a plain markdown file in which case knitting will be bypassed:

render("input.md", html_document())

Additional options can be specified along with the output format:

render("input.Rmd", html_document(toc = TRUE))
render("input.Rmd", pdf_document(latex_engine = "lualatex"))
render("input.Rmd", beamer_presentation(incremental = TRUE))

You can also include arbitrary pandoc command line arguments along with the other options:


render("input.Rmd", pdf_document(toc = TRUE, pandoc_args = "--listings"))

See Also

render, html_document, pdf_document, word_document, beamer_presentation