output_format: Define an R Markdown output format

Description Usage Arguments Value See Also Examples

View source: R/output_format.R

Description

Define an R Markdown output format based on a combination of knitr and pandoc options.

Usage

1
2
3
output_format(knitr, pandoc, keep_md = FALSE, clean_supporting = TRUE,
  pre_processor = NULL, intermediates_generator = NULL,
  post_processor = NULL, base_format = NULL)

Arguments

knitr

Knitr options for an output format (see knitr_options)

pandoc

Pandoc options for an output format (see pandoc_options)

keep_md

Keep the markdown file generated by knitting. Note that if this is TRUE then clean_supporting will always be FALSE.

clean_supporting

Cleanup any supporting files after conversion see render_supporting_files

pre_processor

An optional pre-processor function that receives the metadata, input_file, runtime, knit_meta, files_dir, and output_dir and can return additional arguments to pass to pandoc.

intermediates_generator

An optional function that receives the original input_file, its encoding, and the intermediates directory (i.e. the intermediates_dir argument to render). The function should generate and return the names of any intermediate files required to render the input_file.

post_processor

An optional post-processor function that receives the metadata, input_file, output_file, clean, and verbose parmaeters, and can return an alternative output_file.

base_format

An optional format to extend.

Value

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

See Also

render, knitr_options, pandoc_options

Examples

1
2
3
4
5
## Not run: 
output_format(knitr = knitr_options(opts_chunk = list(dev = 'png')),
              pandoc = pandoc_options(to = "html"))

## End(Not run)

UNFAOstatistics/faodoc documentation built on June 3, 2017, 6:42 a.m.