default_output_format: Determine the default output format for an R Markdown...
In rmarkdown: Dynamic Documents for R
View source: R/output_format.R
default_output_format R Documentation
Determine the default output format for an R Markdown document
Description
Read the YAML metadata (and any common output YAML file) for the
document and return the output format that will be generated by
a call to render.
Usage
default_output_format(input, output_yaml = NULL)
Arguments
input
Input file (Rmd or plain markdown)
output_yaml
Paths to YAML files specifying output formats and their
configurations. The first existing one is used. If none are found, then
the function searches YAML files specified to the output_yaml top-level
parameter in the YAML front matter, _output.yml or _output.yaml, and then uses
the first existing one.
Details
This function is useful for front-end tools that require additional
knowledge of the output to be produced by render (e.g. to
customize the preview experience).
Value
A named list with a name value containing the format
name and an options value that is a list containing all the options
for the format and their values. An option's default value will be returned
if the option isn't set explicitly in the document.
rmarkdown documentation built on Nov. 4, 2024, 5:06 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
View source: R/output_format.R
| default_output_format | R Documentation |
Determine the default output format for an R Markdown document
Description
Read the YAML metadata (and any common output YAML file) for the
document and return the output format that will be generated by
a call to render.
Usage
default_output_format(input, output_yaml = NULL)
Arguments
input |
Input file (Rmd or plain markdown) |
output_yaml |
Paths to YAML files specifying output formats and their
configurations. The first existing one is used. If none are found, then
the function searches YAML files specified to the |
Details
This function is useful for front-end tools that require additional
knowledge of the output to be produced by render (e.g. to
customize the preview experience).
Value
A named list with a name value containing the format
name and an options value that is a list containing all the options
for the format and their values. An option's default value will be returned
if the option isn't set explicitly in the document.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.