-
-
Notifications
You must be signed in to change notification settings - Fork 969
/
rmarkdown.R
29 lines (29 loc) · 1.17 KB
/
rmarkdown.R
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
#' R Markdown Document Conversion
#'
#' Convert R Markdown documents into a variety of formats including HTML,
#' MS Word, PDF, and Beamer.
#' @details The \pkg{rmarkdown} package includes high level functions for
#' converting to a variety of formats. For example:
#' \preformatted{
#' 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:
#' \preformatted{render("input.md", html_document())}
#' Additional options can be specified along with the output format:
#' \preformatted{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:
#' \preformatted{
#' render("input.Rmd", pdf_document(toc = TRUE, pandoc_args = "--listings"))
#' }
#' @seealso \link{render}, \link{html_document}, \link{pdf_document},
#' \link{word_document}, \link{beamer_presentation}
#' @name rmarkdown-package
#' @aliases rmarkdown
#' @docType package
NULL