html_fragment

0th

Percentile

Convert to an HTML fragment.

An html fragment is suitable for inclusion into an external html page. See html_document for full details - this is a minor variation that assumes you will include the output into an existing document (e.g. a blog post).

Usage
html_fragment(number_sections = FALSE, fig_width = 7, fig_height = 5, fig_retina = 2, fig_caption = TRUE, dev = "png", df_print = "default", smart = TRUE, mathjax = TRUE, keep_md = FALSE, md_extensions = NULL, pandoc_args = NULL, ...)
Arguments
number_sections
TRUE to number section headings
fig_width
Default width (in inches) for figures
fig_height
Default width (in inches) for figures
fig_retina
Scaling to perform for retina displays (defaults to 2, which currently works for all widely used retina displays). Set to NULL to prevent retina scaling. Note that this will always be NULL when keep_md is specified (this is because fig_retina relies on outputting HTML directly into the markdown document).
fig_caption
TRUE to render figures with captions
dev
Graphics device to use for figure output (defaults to png)
df_print
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.
smart
Produce typographically correct output, converting straight quotes to curly quotes, --- to em-dashes, -- to en-dashes, and ... to ellipses.
mathjax
TRUE to convert $ and $$ math blocks into MathJax compatible output. Note that you'll still need to ensure that the page where the fragment is included loads the required MathJax scripts.
keep_md
Keep the markdown file generated by knitting.
md_extensions
Markdown extensions to be added or removed from the default definition or R Markdown. See the rmarkdown_format for additional details.
pandoc_args
Additional command line options to pass to pandoc
...
Additional arguments passed to html_document
Details

See the online documentation for additional details on using the html_fragment format.

Value

R Markdown output format to pass to render

Aliases
  • html_fragment
Documentation reproduced from package rmarkdown, version 1.2, License: GPL-3

Community examples

Looks like there are no examples yet.