79 lines
78 KiB
HTML
79 lines
78 KiB
HTML
|
<!DOCTYPE html>
|
||
|
|
<html>
|
||
|
|
<head>
|
||
|
|
<meta charset="utf-8">
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
|
||
|
|
<title>R Markdown with the Docco Linear Style</title>
|
||
|
|
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/katex/dist/katex.min.css">
|
||
|
|
<link rel="stylesheet" href="https://ashkenas.com/docco/resources/linear/public/stylesheets/normalize.css">
|
||
|
|
<link rel="stylesheet" href="https://ashkenas.com/docco/resources/linear/docco.css">
|
||
|
|
<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/rstudio/markdown/inst/resources/prism-xcode.css">
|
||
|
|
<style type="text/css">.container{width:auto;max-width:920px;}.page{width:auto;max-width:800px;}.page pre{width:100%;max-width:768px;}pre, code{font-size:90%;}</style>
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<div class="container"><div class="page">
|
||
|
|
<div class="frontmatter">
|
||
|
|
<div class="title"><h1>R Markdown with the Docco Linear Style</h1></div>
|
||
|
|
<div class="author"><h2></h2></div>
|
||
|
|
<div class="date"><h3></h3></div>
|
||
|
|
</div>
|
||
|
|
<div class="body">
|
||
|
|
<!--
|
||
|
|
%\VignetteEngine{knitr::docco_linear_notangle}
|
||
|
|
%\VignetteIndexEntry{R Markdown with the Docco Linear Style}
|
||
|
|
-->
|
||
|
|
<p>This is an example of Markdown vignettes using the <a href="http://ashkenas.com/docco/">Docco style</a>.</p>
|
||
|
|
<h2 id="docco">Docco</h2>
|
||
|
|
<p>To use the Docco style for Markdown vignettes in an R package, you need to</p>
|
||
|
|
<ul>
|
||
|
|
<li>add <code>*.Rmd</code> files under the <code>vignettes</code> directory</li>
|
||
|
|
<li>add <code>Suggests: knitr</code> and <code>VignetteBuilder: knitr</code> to the <code>DESCRIPTION</code> file</li>
|
||
|
|
<li>specify the vignette engine <code>\VignetteEngine{knitr::docco_linear}</code> in the <code>Rmd</code> files (inside HTML comments)</li>
|
||
|
|
</ul>
|
||
|
|
<p>After building and installing the package, you can view vignettes via</p>
|
||
|
|
<pre><code class="language-r">browseVignettes(package = 'Your_Package')
|
||
|
|
</code></pre>
|
||
|
|
<h2 id="examples">Examples</h2>
|
||
|
|
<p>Below are some code chunks as examples.</p>
|
||
|
|
<pre><code class="language-r">cat('_hello_ **markdown**!', '\n')
|
||
|
|
</code></pre>
|
||
|
|
<p><em>hello</em> <strong>markdown</strong>!</p>
|
||
|
|
<p>Normally you do not need any chunk options.</p>
|
||
|
|
<pre><code class="language-r">1+1
|
||
|
|
</code></pre>
|
||
|
|
<pre><code>## [1] 2
|
||
|
|
</code></pre>
|
||
|
|
<pre><code class="language-r">10:1
|
||
|
|
</code></pre>
|
||
|
|
<pre><code>## [1] 10 9 8 7 6 5 4 3 2 1
|
||
|
|
</code></pre>
|
||
|
|
<pre><code class="language-r">rnorm(5)^2
|
||
|
|
</code></pre>
|
||
|
|
<pre><code>## [1] 0.02793 0.06013 2.93306 0.58198 0.04078
|
||
|
|
</code></pre>
|
||
|
|
<pre><code class="language-r">strsplit('hello, markdown vignettes', '')
|
||
|
|
</code></pre>
|
||
|
|
<pre><code>## [[1]]
|
||
|
|
## [1] "h" "e" "l" "l" "o" "," " " "m" "a" "r" "k" "d" "o" "w" "n" " " "v" "i" "g"
|
||
|
|
## [20] "n" "e" "t" "t" "e" "s"
|
||
|
|
</code></pre>
|
||
|
|
<p>Feel free to draw beautiful plots and write math \(P(X>x)=\alpha/2\).</p>
|
||
|
|
<pre><code class="language-r">n=300; set.seed(123)
|
||
|
|
par(mar=c(4,4,.1,.1))
|
||
|
|
plot(rnorm(n), rnorm(n), pch=21, cex=5*runif(n), col='white', bg='gray')
|
||
|
|
</code></pre>
|
||
|
|
<p><img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAfgAAAH4CAYAAACmKP9/AAAEDmlDQ1BrQ0dDb2xvclNwYWNlR2VuZXJpY1JHQgAAOI2NVV1oHFUUPpu5syskzoPUpqaSDv41lLRsUtGE2uj+ZbNt3CyTbLRBkMns3Z1pJjPj/KRpKT4UQRDBqOCT4P9bwSchaqvtiy2itFCiBIMo+ND6R6HSFwnruTOzu5O4a73L3PnmnO9+595z7t4LkLgsW5beJQIsGq4t5dPis8fmxMQ6dMF90A190C0rjpUqlSYBG+PCv9rt7yDG3tf2t/f/Z+uuUEcBiN2F2Kw4yiLiZQD+FcWyXYAEQfvICddi+AnEO2ycIOISw7UAVxieD/Cyz5mRMohfRSwoqoz+xNuIB+cj9loEB3Pw2448NaitKSLLRck2q5pOI9O9g/t/tkXda8Tbg0+PszB9FN8DuPaXKnKW4YcQn1Xk3HSIry5ps8UQ/2W5aQnxIwBdu7yFcgrxPsRjVXu8HOh0qao30cArp9SZZxDfg3h1wTzKxu5E/LUxX5wKdX5SnAzmDx4A4OIqLbB69yMesE1pKojLjVdoNsfyiPi45hZmAn3uLWdpOtfQOaVmikEs7ovj8hFWpz7EV6mel0L9Xy23FMYlPYZenAx0yDB1/PX6dledmQjikjkXCxqMJS9WtfFCyH9XtSekEF+2dH+P4tzITduTygGfv58a5VCTH5PtXD7EFZiNyUDBhHnsFTBgE0SQIA9pfFtgo6cKGuhooeilaKH41eDs38Ip+f4At1Rq/sjr6NEwQqb/I/DQqsLvaFUjvAx+eWirddAJZnAj1DFJL0mSg/gcIpPkMBkhoyCSJ8lTZIxk0TpKDjXHliJzZPO50dR5ASNSnzeLvIvod0HG/mdkmOC0z8VKnzcQ2M/Yz2vKldduXjp9bleLu0ZWn7vWc+l0JGcaai10yNrUnXLP/8Jf59ewX+c3Wgz+B34Df+vbVrc16zTMVgp9um9bxEfzPU5kPqUtVWxhs6OiWTVW+gIfywB9uXi7CGcGW/zk98k/kmvJ95IfJn/j3uQ+4c5zn3Kfcd+AyF3gLnJfcl9xH3OfR2rUee80a+6vo7EK5mmXUdyfQlrYLTwoZIU9wsPCZEtP6BWGhAlhL3p2N6sTjRdduwbHsG9kq32sgBepc+xurLPW4T9URpYGJ3ym4+8zA05u44QjST8ZIoVtu3qE7fWmdn5LPdqvgcZz8Ww8BWJ8X3w0PhQ/wnCDGd+LvlHs8dRy6bLLDuKMaZ20tZrqisPJ5ONiCq8yKhYM5cCgKOu66Lsc0aYOtZdo5QCwezI4wm9J/v0X23mlZXOfBjj8Jzv3WrY5D+CsA9D7aMs2gGfjve8ArD6mePZSeCfEYt8CONWDw8FXTxrPqx/r9Vt4biXeANh8vV7/+/16ffMD1N8AuKD/A/8leAvFY9bLAAAAOGVYSWZNTQAqAAAACAABh2kABAAAAAEAAAAaAAAAAAACoAIABAAAAAEAAAH4oAMABAAAAAEAAAH4AAAAAAROaeoAAEAASURBVHgB7N15rC1ZVT/wg6IgyIygyPCglaGZm6EHenjdzdztRIyRRBMVojHxD5RoMA6JMUYx0WDU6C9G/zHRGEkM2MzYdEPTDKJo0woo4gMURZkUHMDpdz+l67FfvRp21akz3btWcu85p4Y9rL1rfde0d93hf45olZQcSA4kB5IDyYHkwLHiwB2PVW96OvP85z9/9bGPfWx1l7vcpeeKPJwcSA4kB5IDyYHjwYGPf/zjq7e//e2rEwHw//Ef/7H63d/93dV97nOf4zF62YvkQHIgOZAcSA70cOD6669vznxRz/k8nBxIDiQHkgPJgeTAAXMgAf6ABy+bnhxIDiQHkgPJgT4OJMD3cSaPJweSA8mB5EBy4IA5kAB/wIOXTU8OJAeSA8mB5EAfBxLg+ziTx5MDyYHkQHIgOXDAHEiAP+DBy6YnB5IDyYHkQHKgjwMJ8H2cyePJgeRAciA5kBw4YA6ciHXwBzw+2fTkwFY48O///u+rz33uc6t//ud/Xvl+5zvfeXW3u91tdac73Wn1ZV/2ZVtpQ1aSHEgOLMuBBPhl+ZmlJQcOigM2gfrkJz+5eu9737v6p3/6p/Pafve733114YUXru5973uvvuRLvuS883kgOZAc2F8OpIt+f8cmW5Yc2CgHgPvf/M3fNFtadoG7yln0trx0HQs/KTmQHDgcDiTAH85YZUuTA4tx4L//+79Xn/70p1e33XZbVZmuA/L/9V//VXV9XpQcSA7sngMJ8Lsfg2xBcmDrHPjXf/3X1bve9a5J9b7//e9fuS8pOZAcOAwOJMAfxjhlK5MDi3LgH/7hH1af//znJ5XJpf93f/d3q3zD9CS25cXJgZ1xIAF+Z6zPipMDu+EAYP/7v//7WZV77fJUxWBWRXlTciA5sDYHEuDXZmEWkBw4LA6Io88FafdlHP6wxjtbe3I5kAB/csc+e36COXCHO9xhVu/dN/feWRXmTcmB5MBsDiTAz2Zd3pgcOEwO3PGOd2w2sJnTehvffPEXf/GcW/Oe5EByYMscSIDfMsOzuuTArjlgw5oHPOABs5rxlV/5lasv/dIvnXVv3pQcSA5slwMJ8Nvld9a25xw4KRni973vfVdf/uVfPmk0bFkL4JOSA8mBw+BAblV7GOOUrdwQBySM/du//VuzXauNX/y+613vurr//e+/ustd7nJst2cF1o9+9KObtfA1SXPi7pdddlnuS7+heZjFJgc2wYEE+E1wNcs8CA7YevUjH/nIygYu//mf/3lOm+3NfurUqdXjHve4Y5lUBrBZ8ddff/3qhhtuGMyMF3O/6KKLGtf8F31ROv3OmSj5IzmwxxxIgN/jwcmmbY4DNm350Ic+1Lxkpa+WM2fONMD3yEc+srHm+6471OOS7WxZe8UVV6z+4i/+YvWJT3xida973av5k0yHALpjLP5MrjvUkc52n1QOJMCf1JE/4f3+1Kc+NQjuwR4WPmDzRrXj+DY1AH6Pe9xj9YQnPKF5mYwNcOxW55WxrHyvjeXdEHvP18bGrMjP5MBhcCAB/jDGKVu5IAeA1/ve977qEj/84Q+vLrjggmMJ8MEE4Qp707ffKvcv//IvjWVvB7tLLrkkLs/P5EBy4AA4kAG1AxikbOKyHJBUxoKvJW7sKdfXlrsv1wF3r4Rtg3vZPgB/yy235MtmSqbk9+TAnnMgAX7PByibtzwHxN+n0nF9ixplR5IhS32MxOjlLVB4kpIDyYH950AC/P6PUbZwYQ5ILptKx3VzF9a7mHstffSjH23i87XX53XJgeTA7jiQAL873mfNO+KAxDLJY1NIIloX2RjnkDfHYcHLSailz372swfd39p+5nXJgePAgQT44zCK2YdJHLAE7Ku+6quq77nb3e7Wm0Eu09zfoVJ7/X9NP9JFX8OlvCY5sHsOJMDvfgyyBVvmgGVvD3vYw1aAe4yA91Of+tRegB+7f9/PTw094F2uh9/3Uc32JQf+lwMJ8DkTTiQH7MN+8cUXD+7HDsiA+1R3/iExVB9tZFNL9773vVdzchhqy8/rkgPJgeU4kAC/HC+zpAPjgD3nL7300tXDH/7wxpoHXLG5ywMf+MBmh7ev+IqvONaARnl5xCMeUT1yj3rUo/JtctXcyguTA7vlwPR04t22N2tPDizKAS+UAXCnjvadj9gykD9J7z1nlT/mMY9Z3X777YO8feITn1gV1hgsJE8mB5IDW+NAAvzWWJ0V7SsHZNWf5G1YbcH74Ac/eHX3u9999e53v7t5u145VjwdLPf73e9+x9qbUfY5vycHjgMHEuCPwyhmH5IDa3IAyHu73OWXX97sVmdjH54MHg5/XPl+JyUHkgOHw4EE+MMZq2xpcmCjHCgBfaMVZeHJgeTAVjiQSXZbYXNWkhxIDiQHkgPJge1yIAF+u/zO2pIDyYHkQHIgObAVDiTAb4XNWUlyIDmQHEgOJAe2y4EE+O3yO2tLDiQHkgPJgeTAVjiQAL8VNmclyYHkQHIgOZAc2C4HEuC3y++sLTmQHEgOJAeSA1vh
|
||
|
|
<h2 id="how-does-it-work">How does it work</h2>
|
||
|
|
<p>Custom CSS and JS files are passed to <code>markdown::mark_html()</code> to style the HTML page:</p>
|
||
|
|
<pre><code class="language-r">knitr:::docco_linear
|
||
|
|
</code></pre>
|
||
|
|
<p>That is it.</p>
|
||
|
|
</div>
|
||
|
|
<div class="fleur">h</div></div></div>
|
||
|
|
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.29.0/components/prism-core.min.js" defer></script>
|
||
|
|
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.29.0/plugins/autoloader/prism-autoloader.min.js" defer></script>
|
||
|
|
<script src="https://cdn.jsdelivr.net/combine/npm/katex/dist/katex.min.js,npm/katex/dist/contrib/auto-render.min.js,npm/@xiee/utils/js/render-katex.js" defer></script>
|
||
|
|
<script src="https://cdn.jsdelivr.net/npm/@xiee/utils/js/center-img.min.js" defer></script>
|
||
|
|
</body>
|
||
|
|
</html>
|