resolve_output_format: Resolve the output format for an R Markdown document

In rmarkdown: Dynamic Documents for R

Resolve the output format for an R Markdown document

Description

Read the YAML metadata (and any common output YAML file) for the document and return an output format object that can be passed to the render function.

Usage

resolve_output_format(
  input,
  output_format = NULL,
  output_options = NULL,
  output_yaml = NULL
)

Arguments

input	Input file (Rmd or plain markdown)
output_format	Name of output format (or NULL to use the default format for the input file).
output_options	List of output options that should override the options specified in metadata.
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 need to modify the default behavior of an output format.

Value

An R Markdown output format definition that can be passed to render.

rmarkdown documentation built on Nov. 4, 2024, 5:06 p.m.