Define an R Markdown output format based on a combination of knitr and pandoc options.
output_format(knitr, pandoc, keep_md = FALSE, clean_supporting = TRUE,
df_print = NULL, pre_knit = NULL, post_knit = NULL,
pre_processor = NULL, intermediates_generator = NULL,
post_processor = NULL, on_exit = NULL, base_format = NULL)
Knitr options for an output format (see
knitr_options
)
Pandoc options for an output format (see
pandoc_options
)
Keep the markdown file generated by knitting. Note that
if this is TRUE
then clean_supporting
will always be
FALSE
.
Cleanup any supporting files after conversion see
render_supporting_files
Method to be used for printing data frames. Valid values
include "default", "kable", "tibble", and "paged". The "default" method uses
print.data.frame
. The "kable" method uses the
knitr::kable
function. The "tibble" method uses
the tibble package to print a summary of the data frame. The "paged"
method creates a paginated HTML table (note that this method is only valid
for formats that produce HTML). In addition
to the named methods you can also pass an arbitrary function to be used
for printing data frames. You can disable the df_print
behavior entirely
by setting the option rmarkdown.df_print
to FALSE
.
An optional function that runs before knitting which
receives the input
(input filename passed to render
) and
...
(for future expansion) arguments.
An optional function that runs after knitting which
receives the metadata
, input_file
, runtime
, and ...
(for future expansion) arguments. This function can return additional
arguments to pass to pandoc and can call knitr::knit_meta_add
to add additional dependencies based on the contents of the input_file or on other
assets side by side with it that may be used to produce html with dependencies
during subsequent processing.
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.
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
.
An optional post-processor function that receives the
metadata
, input_file
, output_file
, clean
,
and verbose
parameters, and can return an alternative
output_file
.
A function to call when rmarkdown::render()
finishes
execution (as registered with a on.exit
handler).
An optional format to extend.
An R Markdown output format definition that can be passed to
render
.
# NOT RUN {
output_format(knitr = knitr_options(opts_chunk = list(dev = 'png')),
pandoc = pandoc_options(to = "html"))
# }
Run the code above in your browser using DataLab