-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathch-030-data-driven-docs.html
464 lines (411 loc) · 16.3 KB
/
ch-030-data-driven-docs.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="pandoc" />
<title>Data-Driven Docs</title>
<script src="ch-030-data-driven-docs_files/jquery-1.11.3/jquery.min.js"></script>
<meta name="viewport" content="width=device-width, initial-scale=1" />
<link href="ch-030-data-driven-docs_files/bootstrap-3.3.5/css/readable.min.css" rel="stylesheet" />
<script src="ch-030-data-driven-docs_files/bootstrap-3.3.5/js/bootstrap.min.js"></script>
<script src="ch-030-data-driven-docs_files/bootstrap-3.3.5/shim/html5shiv.min.js"></script>
<script src="ch-030-data-driven-docs_files/bootstrap-3.3.5/shim/respond.min.js"></script>
<script src="ch-030-data-driven-docs_files/navigation-1.1/tabsets.js"></script>
<style type="text/css">code{white-space: pre;}</style>
<style type="text/css" data-origin="pandoc">
a.sourceLine { display: inline-block; line-height: 1.25; }
a.sourceLine { pointer-events: none; color: inherit; text-decoration: inherit; }
a.sourceLine:empty { height: 1.2em; }
.sourceCode { overflow: visible; }
code.sourceCode { white-space: pre; position: relative; }
div.sourceCode { margin: 1em 0; }
pre.sourceCode { margin: 0; }
@media screen {
div.sourceCode { overflow: auto; }
}
@media print {
code.sourceCode { white-space: pre-wrap; }
a.sourceLine { text-indent: -1em; padding-left: 1em; }
}
pre.numberSource a.sourceLine
{ position: relative; left: -4em; }
pre.numberSource a.sourceLine::before
{ content: attr(title);
position: relative; left: -1em; text-align: right; vertical-align: baseline;
border: none; pointer-events: all; display: inline-block;
-webkit-touch-callout: none; -webkit-user-select: none;
-khtml-user-select: none; -moz-user-select: none;
-ms-user-select: none; user-select: none;
padding: 0 4px; width: 4em;
color: #aaaaaa;
}
pre.numberSource { margin-left: 3em; border-left: 1px solid #aaaaaa; padding-left: 4px; }
div.sourceCode
{ background-color: #f8f8f8; }
@media screen {
a.sourceLine::before { text-decoration: underline; }
}
code span.al { color: #ef2929; } /* Alert */
code span.an { color: #8f5902; font-weight: bold; font-style: italic; } /* Annotation */
code span.at { color: #c4a000; } /* Attribute */
code span.bn { color: #0000cf; } /* BaseN */
code span.cf { color: #204a87; font-weight: bold; } /* ControlFlow */
code span.ch { color: #4e9a06; } /* Char */
code span.cn { color: #000000; } /* Constant */
code span.co { color: #8f5902; font-style: italic; } /* Comment */
code span.cv { color: #8f5902; font-weight: bold; font-style: italic; } /* CommentVar */
code span.do { color: #8f5902; font-weight: bold; font-style: italic; } /* Documentation */
code span.dt { color: #204a87; } /* DataType */
code span.dv { color: #0000cf; } /* DecVal */
code span.er { color: #a40000; font-weight: bold; } /* Error */
code span.ex { } /* Extension */
code span.fl { color: #0000cf; } /* Float */
code span.fu { color: #000000; } /* Function */
code span.im { } /* Import */
code span.in { color: #8f5902; font-weight: bold; font-style: italic; } /* Information */
code span.kw { color: #204a87; font-weight: bold; } /* Keyword */
code span.op { color: #ce5c00; font-weight: bold; } /* Operator */
code span.ot { color: #8f5902; } /* Other */
code span.pp { color: #8f5902; font-style: italic; } /* Preprocessor */
code span.sc { color: #000000; } /* SpecialChar */
code span.ss { color: #4e9a06; } /* SpecialString */
code span.st { color: #4e9a06; } /* String */
code span.va { color: #000000; } /* Variable */
code span.vs { color: #4e9a06; } /* VerbatimString */
code span.wa { color: #8f5902; font-weight: bold; font-style: italic; } /* Warning */
</style>
<script>
// apply pandoc div.sourceCode style to pre.sourceCode instead
(function() {
var sheets = document.styleSheets;
for (var i = 0; i < sheets.length; i++) {
if (sheets[i].ownerNode.dataset["origin"] !== "pandoc") continue;
try { var rules = sheets[i].cssRules; } catch (e) { continue; }
for (var j = 0; j < rules.length; j++) {
var rule = rules[j];
// check if there is a div.sourceCode rule
if (rule.type !== rule.STYLE_RULE || rule.selectorText !== "div.sourceCode") continue;
var style = rule.style.cssText;
// check if color or background-color is set
if (rule.style.color === '' || rule.style.backgroundColor === '') continue;
// replace div.sourceCode by a pre.sourceCode rule
sheets[i].deleteRule(j);
sheets[i].insertRule('pre.sourceCode{' + style + '}', j);
}
}
})();
</script>
<style type="text/css">
pre:not([class]) {
background-color: white;
}
</style>
<style type="text/css">
h1 {
font-size: 34px;
}
h1.title {
font-size: 38px;
}
h2 {
font-size: 30px;
}
h3 {
font-size: 24px;
}
h4 {
font-size: 18px;
}
h5 {
font-size: 16px;
}
h6 {
font-size: 12px;
}
.table th:not([align]) {
text-align: left;
}
</style>
<link rel="stylesheet" href="textbook.css" type="text/css" />
</head>
<body>
<style type = "text/css">
.main-container {
max-width: 940px;
margin-left: auto;
margin-right: auto;
}
code {
color: inherit;
background-color: rgba(0, 0, 0, 0.04);
}
img {
max-width:100%;
height: auto;
}
.tabbed-pane {
padding-top: 12px;
}
.html-widget {
margin-bottom: 20px;
}
button.code-folding-btn:focus {
outline: none;
}
summary {
display: list-item;
}
</style>
<div class="container-fluid main-container">
<!-- tabsets -->
<style type="text/css">
.tabset-dropdown > .nav-tabs {
display: inline-table;
max-height: 500px;
min-height: 44px;
overflow-y: auto;
background: white;
border: 1px solid #ddd;
border-radius: 4px;
}
.tabset-dropdown > .nav-tabs > li.active:before {
content: "";
font-family: 'Glyphicons Halflings';
display: inline-block;
padding: 10px;
border-right: 1px solid #ddd;
}
.tabset-dropdown > .nav-tabs.nav-tabs-open > li.active:before {
content: "";
border: none;
}
.tabset-dropdown > .nav-tabs.nav-tabs-open:before {
content: "";
font-family: 'Glyphicons Halflings';
display: inline-block;
padding: 10px;
border-right: 1px solid #ddd;
}
.tabset-dropdown > .nav-tabs > li.active {
display: block;
}
.tabset-dropdown > .nav-tabs > li > a,
.tabset-dropdown > .nav-tabs > li > a:focus,
.tabset-dropdown > .nav-tabs > li > a:hover {
border: none;
display: inline-block;
border-radius: 4px;
}
.tabset-dropdown > .nav-tabs.nav-tabs-open > li {
display: block;
float: none;
}
.tabset-dropdown > .nav-tabs > li {
display: none;
}
</style>
<script>
$(document).ready(function () {
window.buildTabsets("TOC");
});
$(document).ready(function () {
$('.tabset-dropdown > .nav-tabs > li').click(function () {
$(this).parent().toggleClass('nav-tabs-open')
});
});
</script>
<!-- code folding -->
<div class="fluid-row" id="header">
<h1 class="title toc-ignore">Data-Driven Docs</h1>
</div>
<div id="what-are-data-driven-docs" class="section level1">
<h1><span class="header-section-number">1</span> What Are Data-Driven Docs?</h1>
<p>Data-driven documents are formats that combine text and analysis (data+code).</p>
<p>In doing so, they promote transparency and reproducability. For any given table, figure, or model in the document you should be able to easily discern how it was created, from what data, and what analysis was used.</p>
<p>Popular formats include things like <a href="https://rmarkdown.rstudio.com/lesson-1.html">R Markdown</a> documents and <a href="https://jupyter.org/try">Jupyter notebooks</a>.</p>
<p><br></p>
<hr />
<p><br></p>
</div>
<div id="how-do-data-driven-docs-work" class="section level1">
<h1><span class="header-section-number">2</span> How Do Data-Driven Docs Work?</h1>
<p>All of the document formats build from a simple text formatting convention called <a href="https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet"><strong>markdown</strong></a>.</p>
<p>To create an R Markdown document, you need three things:</p>
<ol style="list-style-type: decimal">
<li>A header to specify the document type.<br />
</li>
<li>Some text (formatted in markdown).<br />
</li>
<li>Some code (inside a “code chunk”).</li>
</ol>
<p>You can download a sample template <a href="https://cdn.rawgit.com/DS4PS/Data-Science-Class/c464d527/TEMPLATES/MarkdownTemplateSimple.Rmd">HERE</a>.</p>
<p><br></p>
<p><img src="figures/knit.png" /></p>
<p><br> <br></p>
<p><a href="../gifs/NewRmarkdownFile/NewRmarkdownFile.html"><img src="https://github.com/DS4PS/ds4ps.github.io/blob/master/gifs/NewRmarkdownFile/NewRmarkdownFile_media/NewRmarkdownFile.gif?raw=true" /></a></p>
<p><br></p>
<hr />
<p><br></p>
</div>
<div id="what-is-markdown" class="section level1">
<h1><span class="header-section-number">3</span> What is Markdown?</h1>
<p>Markdown is a simple set of rules used to format text. It has been adopted broadly by the data science community and is used on GitHub, Stackoverflow, and now in R Studio.</p>
<p>To give just a couple of examples of how it works:</p>
<p><strong>Unordered Lists</strong></p>
<pre><code>* First item
* Second item
* Third item
* First nested item
* Second nested item</code></pre>
<ul>
<li>First item</li>
<li>Second item</li>
<li>Third item
<ul>
<li>First nested item</li>
<li>Second nested item</li>
</ul></li>
</ul>
<p><strong>Hyperlinks</strong></p>
<p>Create links by wrapping the link text in square brackets [ ], and the URL in adjacent parentheses ( ).</p>
<pre><code>I find that [Google News](https://news.google.com) over-curates my media diet.</code></pre>
<p>I find that <a href="https://news.google.com"><strong>Google News</strong></a> over-curates my media diet.</p>
<p><br></p>
<p><strong>Tables</strong></p>
<pre><code>| Title 1 | Title 2 |
|------------------|------------------|
| First entry | Second entry |
| Third entry | Fourth entry |
| Fifth entry | Sixth entry |</code></pre>
<table>
<thead>
<tr class="header">
<th>Title 1</th>
<th>Title 2</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>First entry</td>
<td>Second entry</td>
</tr>
<tr class="even">
<td>Third entry</td>
<td>Fourth entry</td>
</tr>
<tr class="odd">
<td>Fifth entry</td>
<td>Sixth entry</td>
</tr>
</tbody>
</table>
<p>You can see a full list of <strong>markdown rules</strong> <a href="https://ds4ps.org/data-driven-management-textbook/markdown/">HERE</a>.</p>
<p><br></p>
<hr />
<p><br></p>
</div>
<div id="knitting-r-markdown-files" class="section level1">
<h1><span class="header-section-number">4</span> Knitting R Markdown Files</h1>
<p>Code is placed inside of “chunks” in the documents:</p>
<p><a href="../gifs/NewCodeChunk/NewCodeChunk.html"><img src="https://github.com/DS4PS/ds4ps.github.io/blob/master/gifs/NewCodeChunk/NewCodeChunk_media/NewCodeChunk.gif?raw=true" /></a></p>
<p>When you “knit” a file R Studio will run all of code, embed the output into your document, and then convert the file to whichever type you have specified in the file header.</p>
<p><br></p>
<p><img src="figures/knitting.png" /></p>
<p><br></p>
<hr />
<p><br></p>
</div>
<div id="output-types" class="section level1">
<h1><span class="header-section-number">5</span> Output Types</h1>
<p>You can select from many different document types, including HTML pages, Microsoft word, presentation formats, or dashboards.</p>
<p><br></p>
<p><span style="display:block;text-align:center"> <img src="figures/rmd_output_types.png" /> </span></p>
<p><strong>Check out these examples:</strong></p>
<p><a href="https://rmarkdown.rstudio.com/formats.html">R Markdown Formats</a><br />
<a href="https://rmarkdown.rstudio.com/gallery.html">R Markdown Gallery</a></p>
<p><br></p>
<hr />
<p><br></p>
<div id="html-pages" class="section level3">
<h3><span class="header-section-number">5.0.1</span> HTML Pages</h3>
<div class="sourceCode" id="cb4"><pre class="sourceCode r"><code class="sourceCode r"><a class="sourceLine" id="cb4-1" title="1"><span class="op">---</span></a>
<a class="sourceLine" id="cb4-2" title="2">output<span class="op">:</span><span class="st"> </span>html_document</a>
<a class="sourceLine" id="cb4-3" title="3"><span class="op">---</span></a></code></pre></div>
<p><a href="../gifs/html_format/html_format.html"><img src="https://github.com/DS4PS/ds4ps.github.io/blob/master/gifs/html_format/html_format_media/html_format.gif?raw=true" /></a></p>
<p><br></p>
</div>
<div id="dashboards" class="section level3">
<h3><span class="header-section-number">5.0.2</span> Dashboards</h3>
<div class="sourceCode" id="cb5"><pre class="sourceCode r"><code class="sourceCode r"><a class="sourceLine" id="cb5-1" title="1"><span class="op">---</span></a>
<a class="sourceLine" id="cb5-2" title="2">output<span class="op">:</span><span class="st"> </span>flexdashboard<span class="op">::</span>flex_dashboard<span class="op">:</span></a>
<a class="sourceLine" id="cb5-3" title="3"><span class="op">---</span></a></code></pre></div>
<p><a href="../gifs/DashboardExample/DashboardExample2.html"><img src="https://github.com/DS4PS/ds4ps.github.io/blob/master/assets/img/DashboardExample.gif?raw=true" /></a></p>
<p>[ <a href="https://cultureofinsight.shinyapps.io/crypto_tracker/">dashboard example</a> ] [ <a href="https://cultureofinsight.shinyapps.io/crypto_tracker/">source code</a> ] [ <a href="https://www.cultureofinsight.com/blog/2018/01/22/2018-01-22-building-a-cryptocurrency-tracker-with-r/">blog about the tracker</a> ]</p>
<p><br></p>
</div>
<div id="pdfs" class="section level3">
<h3><span class="header-section-number">5.0.3</span> PDFs</h3>
<div class="sourceCode" id="cb6"><pre class="sourceCode r"><code class="sourceCode r"><a class="sourceLine" id="cb6-1" title="1"><span class="op">---</span></a>
<a class="sourceLine" id="cb6-2" title="2">output<span class="op">:</span><span class="st"> </span>pdf_document</a>
<a class="sourceLine" id="cb6-3" title="3"><span class="op">---</span></a></code></pre></div>
<p><br></p>
<hr />
<p><br></p>
</div>
</div>
<div id="installation" class="section level1">
<h1><span class="header-section-number">6</span> Installation</h1>
<p>You will need the following programs to generate data-driven documents in R:</p>
<ul>
<li>Base R installation <a href="https://www.r-project.org/">CRAN</a></li>
<li>R Studio <a href="https://www.rstudio.com/products/rstudio/download/#Installers">download page</a></li>
<li>Pandoc (<a href="https://blog.rstudio.com/2014/06/18/r-markdown-v2/">comes with R Studio by default</a>)</li>
</ul>
<p>When you first try to knit a file, you might get a message that you need the following packages:</p>
<ul>
<li>rmarkdown<br />
</li>
<li>knitr</li>
</ul>
<p>These can be installed in the usual manner:</p>
<div class="sourceCode" id="cb7"><pre class="sourceCode r"><code class="sourceCode r"><a class="sourceLine" id="cb7-1" title="1"><span class="kw">install.packages</span>( <span class="st">"rmarkdown"</span> )</a>
<a class="sourceLine" id="cb7-2" title="2"><span class="kw">install.packages</span>( <span class="st">"knitr"</span> )</a></code></pre></div>
<p><strong>PDFs:</strong></p>
<p>If you would like to knit to PDF you need one additional program. TeX creates publication-quality PDF files. The open-source version is called MiKTeX <a href="http://miktex.org/download">download page</a>.</p>
<p>If you have problems, you can find some nice tutorials like this one: <a href="https://www.reed.edu/data-at-reed/software/R/r_studio_pc.html" class="uri">https://www.reed.edu/data-at-reed/software/R/r_studio_pc.html</a></p>
<p><strong>Specialized packages:</strong></p>
<p>Some document output formats require specific R packages. For example:</p>
<ul>
<li>journal templates<br />
</li>
<li>dashboards<br />
</li>
<li>r websites<br />
</li>
<li>books in bookdown</li>
</ul>
<p>You can find many of these packages on the <a href="https://rmarkdown.rstudio.com/formats.html">R Markdown templates page</a>.</p>
<p><br> <br> <br></p>
</div>
</div>
<script>
// add bootstrap table styles to pandoc tables
function bootstrapStylePandocTables() {
$('tr.header').parent('thead').parent('table').addClass('table table-condensed');
}
$(document).ready(function () {
bootstrapStylePandocTables();
});
</script>
<!-- dynamically load mathjax for compatibility with self-contained -->
<script>
(function () {
var script = document.createElement("script");
script.type = "text/javascript";
script.src = "https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML";
document.getElementsByTagName("head")[0].appendChild(script);
})();
</script>
</body>
</html>