You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
260 lines
10 KiB
260 lines
10 KiB
<!-- Generated by pkgdown: do not edit by hand -->
|
|
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
<title>ipsum R markdown template — ipsum • hrbrthemes</title>
|
|
|
|
<!-- jquery -->
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js" integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8=" crossorigin="anonymous"></script>
|
|
<!-- Bootstrap -->
|
|
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha256-916EbMg70RQy9LHiGkXzG8hSg9EdNy97GazNG/aiY1w=" crossorigin="anonymous" />
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha256-U5ZEeKfGNOja007MMD3YBI0A3OSZOQbeG6z2f2Y0hu8=" crossorigin="anonymous"></script>
|
|
|
|
<!-- Font Awesome icons -->
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css" integrity="sha256-eZrrJcwDc/3uDhsdt61sL2oOBY362qM3lon1gyExkL0=" crossorigin="anonymous" />
|
|
|
|
<!-- clipboard.js -->
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.4/clipboard.min.js" integrity="sha256-FiZwavyI2V6+EXO1U+xzLG3IKldpiTFf3153ea9zikQ=" crossorigin="anonymous"></script>
|
|
|
|
<!-- sticky kit -->
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/sticky-kit/1.1.3/sticky-kit.min.js" integrity="sha256-c4Rlo1ZozqTPE2RLuvbusY3+SU1pQaJC0TjuhygMipw=" crossorigin="anonymous"></script>
|
|
|
|
<!-- pkgdown -->
|
|
<link href="../pkgdown.css" rel="stylesheet">
|
|
<script src="../pkgdown.js"></script>
|
|
|
|
|
|
|
|
<meta property="og:title" content="ipsum R markdown template — ipsum" />
|
|
|
|
<meta property="og:description" content="Template for creating an R markdown document with an emphasis on typography" />
|
|
<meta name="twitter:card" content="summary" />
|
|
|
|
|
|
|
|
<!-- mathjax -->
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script>
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script>
|
|
|
|
<!--[if lt IE 9]>
|
|
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
|
|
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
|
|
<![endif]-->
|
|
|
|
|
|
</head>
|
|
|
|
<body>
|
|
<div class="container template-reference-topic">
|
|
<header>
|
|
<div class="navbar navbar-default navbar-fixed-top" role="navigation">
|
|
<div class="container">
|
|
<div class="navbar-header">
|
|
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false">
|
|
<span class="sr-only">Toggle navigation</span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
</button>
|
|
<span class="navbar-brand">
|
|
<a class="navbar-link" href="../index.html">hrbrthemes</a>
|
|
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">0.6.0</span>
|
|
</span>
|
|
</div>
|
|
|
|
<div id="navbar" class="navbar-collapse collapse">
|
|
<ul class="nav navbar-nav">
|
|
<li>
|
|
<a href="../index.html">
|
|
<span class="fa fa-home fa-lg"></span>
|
|
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="../reference/index.html">Reference</a>
|
|
</li>
|
|
<li class="dropdown">
|
|
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">
|
|
Articles
|
|
|
|
<span class="caret"></span>
|
|
</a>
|
|
<ul class="dropdown-menu" role="menu">
|
|
<li>
|
|
<a href="../articles/why_hrbrthemes.html">Why hrbrthemes?</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<a href="../news/index.html">Changelog</a>
|
|
</li>
|
|
</ul>
|
|
|
|
<ul class="nav navbar-nav navbar-right">
|
|
<li>
|
|
<a href="https://github.com/hrbrmstr/hrbrthemes">
|
|
<span class="fa fa-github fa-lg"></span>
|
|
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
|
|
</div><!--/.nav-collapse -->
|
|
</div><!--/.container -->
|
|
</div><!--/.navbar -->
|
|
|
|
|
|
</header>
|
|
|
|
<div class="row">
|
|
<div class="col-md-9 contents">
|
|
<div class="page-header">
|
|
<h1>ipsum R markdown template</h1>
|
|
<small class="dont-index">Source: <a href='https://github.com/hrbrmstr/hrbrthemes/blob/master/R/ipsum.r'><code>R/ipsum.r</code></a></small>
|
|
<div class="hidden name"><code>ipsum.Rd</code></div>
|
|
</div>
|
|
|
|
<div class="ref-description">
|
|
|
|
<p>Template for creating an R markdown document with an emphasis on typography</p>
|
|
|
|
</div>
|
|
|
|
<pre class="usage"><span class='fu'>ipsum</span>(<span class='kw'>number_sections</span> <span class='kw'>=</span> <span class='fl'>FALSE</span>, <span class='kw'>fig_width</span> <span class='kw'>=</span> <span class='fl'>7</span>, <span class='kw'>fig_height</span> <span class='kw'>=</span> <span class='fl'>5</span>,
|
|
<span class='kw'>fig_retina</span> <span class='kw'>=</span> <span class='kw'>if</span> (!<span class='no'>fig_caption</span>) <span class='fl'>2</span>, <span class='kw'>fig_caption</span> <span class='kw'>=</span> <span class='fl'>FALSE</span>, <span class='kw'>dev</span> <span class='kw'>=</span> <span class='st'>"png"</span>,
|
|
<span class='kw'>smart</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>, <span class='kw'>self_contained</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>, <span class='kw'>highlight</span> <span class='kw'>=</span> <span class='st'>"default"</span>,
|
|
<span class='kw'>mathjax</span> <span class='kw'>=</span> <span class='st'>"default"</span>, <span class='kw'>extra_dependencies</span> <span class='kw'>=</span> <span class='kw'>NULL</span>, <span class='kw'>css</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
|
|
<span class='kw'>includes</span> <span class='kw'>=</span> <span class='kw'>NULL</span>, <span class='kw'>keep_md</span> <span class='kw'>=</span> <span class='fl'>FALSE</span>, <span class='kw'>lib_dir</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
|
|
<span class='kw'>md_extensions</span> <span class='kw'>=</span> <span class='kw'>NULL</span>, <span class='kw'>pandoc_args</span> <span class='kw'>=</span> <span class='kw'>NULL</span>, <span class='kw'>toc</span> <span class='kw'>=</span> <span class='fl'>FALSE</span>,
|
|
<span class='kw'>toc_depth</span> <span class='kw'>=</span> <span class='fl'>2</span>, <span class='no'>...</span>)</pre>
|
|
|
|
<h2 class="hasAnchor" id="arguments"><a class="anchor" href="#arguments"></a>Arguments</h2>
|
|
<table class="ref-arguments">
|
|
<colgroup><col class="name" /><col class="desc" /></colgroup>
|
|
<tr>
|
|
<th>number_sections</th>
|
|
<td><p><code>TRUE</code> to number section headings</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>fig_width</th>
|
|
<td><p>Default width (in inches) for figures</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>fig_height</th>
|
|
<td><p>Default height (in inches) for figures</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>fig_retina</th>
|
|
<td><p>Scaling to perform for retina displays (defaults to 2, which
|
|
currently works for all widely used retina displays). Set to <code>NULL</code> to
|
|
prevent retina scaling. Note that this will always be <code>NULL</code> when
|
|
<code>keep_md</code> is specified (this is because <code>fig_retina</code> relies on
|
|
outputting HTML directly into the markdown document).</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>fig_caption</th>
|
|
<td><p><code>TRUE</code> to render figures with captions</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>dev</th>
|
|
<td><p>Graphics device to use for figure output (defaults to png)</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>smart</th>
|
|
<td><p>Produce typographically correct output, converting straight
|
|
quotes to curly quotes, --- to em-dashes, -- to en-dashes, and ... to
|
|
ellipses.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>self_contained</th>
|
|
<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>
|
|
<th>highlight</th>
|
|
<td><p>Syntax highlighting style. Supported styles include
|
|
"default", "tango", "pygments", "kate", "monochrome", "espresso", "zenburn",
|
|
"haddock", and "textmate". Pass <code>NULL</code> to prevent syntax highlighting.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>mathjax</th>
|
|
<td><p>Include mathjax. The "default" option uses an https URL from a
|
|
MathJax CDN. The "local" option uses a local version of MathJax (which is
|
|
copied into the output directory). You can pass an alternate URL or pass
|
|
<code>NULL</code> to exclude MathJax entirely.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>extra_dependencies, ...</th>
|
|
<td><p>Additional function arguments to pass to the
|
|
base R Markdown HTML output formatter</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>css</th>
|
|
<td><p>One or more css files to include</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>includes</th>
|
|
<td><p>Named list of additional content to include within the
|
|
document (typically created using the <code>includes</code> function).</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>keep_md</th>
|
|
<td><p>Keep the markdown file generated by knitting.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>lib_dir</th>
|
|
<td><p>Directory to copy dependent HTML libraries (e.g. jquery,
|
|
bootstrap, etc.) into. By default this will be the name of the document with
|
|
<code>_files</code> appended to it.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>md_extensions</th>
|
|
<td><p>Markdown extensions to be added or removed from the
|
|
default definition or R Markdown. See the <code>rmarkdown_format</code> for
|
|
additional details.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>pandoc_args</th>
|
|
<td><p>Additional command line options to pass to pandoc</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>toc, toc_depth</th>
|
|
<td><p>TOC params</p></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
</div>
|
|
<div class="col-md-3 hidden-xs hidden-sm" id="sidebar">
|
|
<h2>Contents</h2>
|
|
<ul class="nav nav-pills nav-stacked">
|
|
<li><a href="#arguments">Arguments</a></li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<footer>
|
|
<div class="copyright">
|
|
<p>Developed by Bob Rudis.</p>
|
|
</div>
|
|
|
|
<div class="pkgdown">
|
|
<p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.2.0.</p>
|
|
</div>
|
|
</footer>
|
|
</div>
|
|
|
|
|
|
|
|
</body>
|
|
</html>
|
|
|
|
|