Convert to an HTML vignette
A HTML vignette is a lightweight alternative to
suitable for inclusion in packages to be released to CRAN. It reduces the
size of a basic vignette from 100k to around 10k.
html_vignette( fig_width = 3, fig_height = 3, dev = "png", df_print = "default", css = NULL, keep_md = FALSE, readme = FALSE, self_contained = TRUE, ... )
Default width (in inches) for figures
Default height (in inches) for figures
Graphics device to use for figure output (defaults to png)
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::kablefunction. 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_printbehavior entirely by setting the option
One or more css files to include
Keep the markdown file generated by knitting.
Use this vignette as the package README.md file (i.e. render it as README.md to the package root). Note that if there are image files within your vignette you should be sure to add README_files to .Rbuildignore
Produce a standalone HTML file with no external dependencies, using data: URIs to incorporate the contents of linked scripts, stylesheets, images, and videos. Note that even for self contained documents MathJax is still loaded externally (this is necessary because of its size).
Additional arguments passed to
html_document. Please note that
highlightare hard coded. Setting any of those will yield an error.
never uses retina figures
never uses a theme
has a smaller default figure size
uses a custom css stylesheet
uses a custom highlight scheme
See the online
documentation for additional details on using the
R Markdown output format to pass to