Learn R Programming

pkgmaker (version 0.31)

render_notes: Renders rmarkdown Documents Using User Default Options

Description

Renders rmarkdown Documents Using User Default Options

Usage

render_notes(input, output_format = NULL, output_options = NULL, ...,
  .config = NULL)

Arguments

input

Input file (R script, Rmd, or plain markdown).

output_format

R Markdown output format to convert to. Pass "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 multiple formats. Alternatively you can pass an output format object; e.g. html_document(). If NULL is passed then the output format is the first one defined in the YAML metadata of the input file (defaulting to HTML if none is specified).

output_options

List of output options that can override the options specified in metadata (e.g. could be used to force self_contained or mathjax = "local"). Note that this is only valid when the output format is read from metadata (i.e. not a custom format object passed to output_format).

...

other arguments passed to render

.config

location of the default options (a YAML file). Default behaviour is to look for file '.rmarkdown.yaml' in the user's home directory, or, if missing, for a yaml section rmarkdown::render in the user's R profile.

See Also

read.yaml_section