EVOLUTION-MANAGER
Edit File: html_vignette.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><title>R: Convert to an HTML vignette</title> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <link rel="stylesheet" type="text/css" href="R.css" /> </head><body> <table width="100%" summary="page for html_vignette {rmarkdown}"><tr><td>html_vignette {rmarkdown}</td><td style="text-align: right;">R Documentation</td></tr></table> <h2>Convert to an HTML vignette</h2> <h3>Description</h3> <p>A HTML vignette is a lightweight alternative to <code><a href="html_document.html">html_document</a></code> suitable for inclusion in packages to be released to CRAN. It reduces the size of a basic vignette from 100k to around 10k. </p> <h3>Usage</h3> <pre> html_vignette( fig_width = 3, fig_height = 3, dev = "png", df_print = "default", css = NULL, keep_md = FALSE, readme = FALSE, self_contained = TRUE, ... ) </pre> <h3>Arguments</h3> <table summary="R argblock"> <tr valign="top"><td><code>fig_width</code></td> <td> <p>Default width (in inches) for figures</p> </td></tr> <tr valign="top"><td><code>fig_height</code></td> <td> <p>Default height (in inches) for figures</p> </td></tr> <tr valign="top"><td><code>dev</code></td> <td> <p>Graphics device to use for figure output (defaults to png)</p> </td></tr> <tr valign="top"><td><code>df_print</code></td> <td> <p>Method to be used for printing data frames. Valid values include "default", "kable", "tibble", and "paged". The "default" method uses a corresponding S3 method of <code>print</code>, typically <code>print.data.frame</code>. The "kable" method uses the <code><a href="../../knitr/html/kable.html">knitr::kable</a></code> function. The "tibble" method uses the <span class="pkg">tibble</span> 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 <code>df_print</code> behavior entirely by setting the option <code>rmarkdown.df_print</code> to <code>FALSE</code>.</p> </td></tr> <tr valign="top"><td><code>css</code></td> <td> <p>One or more css files to include</p> </td></tr> <tr valign="top"><td><code>keep_md</code></td> <td> <p>Keep the markdown file generated by knitting.</p> </td></tr> <tr valign="top"><td><code>readme</code></td> <td> <p>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</p> </td></tr> <tr valign="top"><td><code>self_contained</code></td> <td> <p>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).</p> </td></tr> <tr valign="top"><td><code>...</code></td> <td> <p>Additional arguments passed to <code><a href="html_document.html">html_document</a></code>. Please note that <code>theme</code>, <code>fig_retina</code> and <code>highlight</code> are hard coded. Setting any of those will yield an error.</p> </td></tr> </table> <h3>Details</h3> <p>Compared to <code>html_document</code>, it: </p> <ul> <li><p> never uses retina figures </p> </li> <li><p> never uses a theme </p> </li> <li><p> has a smaller default figure size </p> </li> <li><p> uses a custom css stylesheet </p> </li> <li><p> uses a custom highlight scheme </p> </li></ul> <p>See the <a href="https://rmarkdown.rstudio.com/package_vignette_format.html">online documentation</a> for additional details on using the <code>html_vignette</code> format. </p> <h3>Value</h3> <p>R Markdown output format to pass to <code><a href="render.html">render</a></code> </p> <hr /><div style="text-align: center;">[Package <em>rmarkdown</em> version 2.3 <a href="00Index.html">Index</a>]</div> </body></html>