knit
is called prior to pandoc.render(input, output_format = NULL, output_file = NULL, output_dir = NULL,
output_options = NULL, intermediates_dir = NULL,
runtime = c("auto", "static", "shiny"),
clean = TRUE, params = NULL, knit_meta = NULL, envir = parent.frame(),
run_pandoc = TRUE, quiet = FALSE, encoding = getOption("encoding"))
"all"
to render all formats defined within the file. Pass
the name of a format (e.g. "html_document"
) to render a single
format or pass a vector of format names to render multiplself_contained
or
mathjax = "local"
). Note that this is only valid when the output
format is read from metadata (i.e. nNULL
then a default based on
the name of the input file is chosen.NULL
,
intermediate files are written to the same directory as the input file;
otherwis.static
produces output
intended for static files; shiny
produces output suitable for use in a
Shiny document (see run
). The default, auto
TRUE
to clean intermediate files created
during rendering."ask"
to start
an application that helps guide parameter configurnew.env()
to guarantee an empty new
environment).TRUE
to supress printing of the
pandoc command line.file
.run_pandoc = TRUE
, the compiled document is written into the output
file, and the path of the output file is returned.When run_pandoc = FALSE
, the path of the Markdown output file, with
attributes knit_meta
(the intermediates
(the intermediate files/directories generated
by render()
).
rmarkdown_format
for details.error
option is set to FALSE
during rendering (which is different from the TRUE
).For additional details on rendering R scripts see Compiling R scripts to a notebook.
If no output_format
parameter is specified then the output
format is read from the YAML front-matter of the input
file. For example, the following YAML would yield a PDF
document:
output: pdf_document
Additional format options can also be specified in metadata. For example:
output: pdf_document: toc: true highlight: zenburn
Multiple formats can be specified in metadata. If no output_format
is passed to render
then the first one defined will be used:
output: pdf_document: toc: true highlight: zenburn html_document: toc: true theme: united
Formats specified in metadata can be any one of the built in formats
(e.g. html_document
,
pdf_document
) or a format defined in another
package (e.g. pkg::custom_format
).
If there is no format defined in the YAML then
html_document
will be used.
library(rmarkdown)
# render the default (first) format defined in the file
render("input.Rmd")
# render all formats defined in the file
render("input.Rmd", "all")
# render a single format
render("input.Rmd", "html_document")
# render multiple formats
render("input.Rmd", c("html_document", "pdf_document"))
Run the code above in your browser using DataLab