File: rmarkdown-package.Rd

package info (click to toggle)
r-cran-rmarkdown 2.20%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 8,028 kB
  • sloc: javascript: 5,656; sh: 24; makefile: 17
file content (36 lines) | stat: -rw-r--r-- 1,251 bytes parent folder | download | duplicates (2)
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
30
31
32
33
34
35
36
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/rmarkdown.R
\docType{package}
\name{rmarkdown-package}
\alias{rmarkdown-package}
\alias{rmarkdown}
\title{R Markdown Document Conversion}
\description{
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}
}