-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathsession6A_talk1.html
458 lines (368 loc) · 11.7 KB
/
session6A_talk1.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
<!DOCTYPE html>
<html lang="" xml:lang="">
<head>
<title>Easy R Markdown Reporting with {chronicle}</title>
<meta charset="utf-8" />
<meta name="author" content="Philippe Heymans Smith - @pheymanss" />
<script src="libs/header-attrs-2.8/header-attrs.js"></script>
<link href="libs/remark-css-0.0.1/useR.css" rel="stylesheet" />
<link href="libs/remark-css-0.0.1/useR-fonts.css" rel="stylesheet" />
<link href="libs/tile-view-0.2.6/tile-view.css" rel="stylesheet" />
<script src="libs/tile-view-0.2.6/tile-view.js"></script>
<script src="libs/xaringanExtra-webcam-0.0.1/webcam.js"></script>
<script id="xaringanExtra-webcam-options" type="application/json">{"width":"200","height":"200","margin":"1em"}</script>
<script src="libs/htmlwidgets-1.5.3/htmlwidgets.js"></script>
<script src="libs/pymjs-1.3.2/pym.v1.js"></script>
<script src="libs/widgetframe-binding-0.3.1/widgetframe.js"></script>
</head>
<body>
<textarea id="source">
class: center, middle, inverse, title-slide
# Easy R Markdown Reporting with {chronicle}
### Philippe Heymans Smith - <span class="citation">@pheymanss</span>
---
<style type="text/css">
.white{
color: white;
}
a:link {
color: white;
text-decoration: underline;
font-size: 20px;
}
a:visited {
color: white;
text-decoration: underline;
font-size: 20px;
}
a:hover {
background-color: yellow;
}
.code{
background-color: #d9d9d9;
color: black;
font-family: Source Code Pro
}
.warning{
color: red;
font-weight: bold;
font-size: 20px;
}
.highlight{
background-color: gold
}
</style>
## chronicle
An opinionated assistant that makes R Markdown reports for you.
--
```r
library(chronicle)
demo_report <-
add_table(table = head(iris),
table_title = "A glimpse at the iris dataset",
html_table_type = "kable") %>%
add_raincloud(dt = iris,
value = "Sepal.Length",
groups = "Species") %>%
add_text(text = c('Add text between elements like these!',
stringi::stri_rand_lipsum(1))) %>%
add_boxplot(dt = palmerpenguins::penguins,
value = 'body_mass_g',
groups = 'island',
split_groups_by = 'sex')
```
--
```r
render_report(demo_report)
```
---
### supported elements
- Bar plots
- Box plots
- Code chunks
- Density plots
- dygraphs
- Histograms
- Images
- Line plots
- Plain tex
- Raincloud plots
- Scatter plots
- Tables (kable and DT.js)
- Violin plots
---
```r
demo_report
```
--
<img src="demo_report.png" title="The variable demo_report reveals itself to be a character string containing all the usual content you would expect looking at the content of an R Markdown file: backticks and brackets opening and closing R code chunks, numeral symbols specifying headers, and plain text inbetween code chunks." alt="The variable demo_report reveals itself to be a character string containing all the usual content you would expect looking at the content of an R Markdown file: backticks and brackets opening and closing R code chunks, numeral symbols specifying headers, and plain text inbetween code chunks." width="855" />
---
## make_ family of functions
```r
chronicle::make_boxplot(dt = palmerpenguins::penguins,
value = 'body_mass_g',
groups = 'island',
split_groups_by = 'sex',
jitter = TRUE,
plot_palette_generator = 'viridis',
static = FALSE)
```
--
<div id="htmlwidget-89f93bdb968a0608697b" style="width:100%;height:270px;" class="widgetframe html-widget"></div>
<script type="application/json" data-for="htmlwidget-89f93bdb968a0608697b">{"x":{"url":"index_files/figure-html//widgets/widget_unnamed-chunk-8.html","options":{"xdomain":"*","allowfullscreen":false,"lazyload":false}},"evals":[],"jsHooks":[]}</script>
---
## make_ family of functions
```r
chronicle::make_boxplot(dt = palmerpenguins::penguins,
value = 'body_mass_g',
groups = 'island',
split_groups_by = 'sex',
jitter = TRUE,
plot_palette_generator = 'viridis',
static = FALSE)
```
.warning[But please do learn ggplot2!]
---
### Rendering
```r
render_report(report = director_report,
output_format = 'word_document',
title = 'Director report',
filename = 'director_obs',
docx_reference_file = 'institution_template.docx')
```
--
```r
render_report(report = niche_report,
output_format = 'pagedown',
filename = 'Niche Team')
```
--
```r
render_report(report = lab_report,
output_format = c('rmdformats','pdf')
title = paste('Lab Observations', Sys.Date()),
filename = paste('lab_observations', Sys.Date()))
```
---
### Rendering Options
- File name (default is a generic name with date)
- Title and author
- Include date
- Directory for the output
- Output format (several at a time)
- Keep the .Rmd file it wrote
- Render the report or not
- Include table of contents (when formats allow it)
- Table of content depth
- Number the sections
- Figure width and height
- Plot pallete
- Plot palette generator (viridis)
- Themes
- html_theme
- rmdformats
- prettydoc
- Microsoft Word and PowerPoint reference files
---
---
## Output formats
.pull-left[
### Interactive
- bookdown
- html_document
- html_notebook
- ioslides
- prettydoc
- rmdformats (default)
- slidy_presentation
- tufte_html
]
.pull-right[
### Static
- github_document
- pagedown
- pdf
- powerpoint_presentation
- rolldown
- tufte_handout
- word_document
]
---
## report_columns()
```r
report_columns(palmerpenguins::penguins)
```
--
```r
report_columns(palmerpenguins::penguins,
by_column = 'species')
```
---
## Limitations
--
1. Plotly's limitations
--
(my ignorance of plotly solutions?)
--
- Compatibility of custom geoms.
--
- Data sizes translate to report file sizes.
--
- If over 10,000 rows, it rolls back into static ggplot2
--
(ugly line on the sand, sorry)
--
2. Unsupported formats:
--
- xaringan
--
- flexdashboard
--
- rticles
--
(please don't)
--
3. Anything that is not currently supported
--
: .code[add_code()]
--
```r
add_code(code = 'corrplot::corrplot(cor(mtcars))', eval = TRUE)
```
--
```
## ```{r, eval=TRUE, echo=TRUE, fig.width=params$figure_width, fig.height=params$figure_height}
## corrplot::corrplot(cor(mtcars))
## ```
```
---
class: chapter-slide
# Thank you!
.white[
Reach out [@pheymanss](https://twitter.com/pheymanss)
- Package repository - https://github.com/pheymanss/chronicle
- Full showcase of chronicle elements - https://pheymanss.github.io/chronicle-demos/showcase
]
</textarea>
<style data-target="print-only">@media screen {.remark-slide-container{display:block;}.remark-slide-scaler{box-shadow:none;}}</style>
<script src="https://remarkjs.com/downloads/remark-latest.min.js"></script>
<script>var slideshow = remark.create({
"ratio": "16:9",
"slideNumberFormat": "%current%",
"highlightStyle": "github",
"highlightLines": true,
"countIncrementalSlides": false
});
if (window.HTMLWidgets) slideshow.on('afterShowSlide', function (slide) {
window.dispatchEvent(new Event('resize'));
});
(function(d) {
var s = d.createElement("style"), r = d.querySelector(".remark-slide-scaler");
if (!r) return;
s.type = "text/css"; s.innerHTML = "@page {size: " + r.style.width + " " + r.style.height +"; }";
d.head.appendChild(s);
})(document);
(function(d) {
var el = d.getElementsByClassName("remark-slides-area");
if (!el) return;
var slide, slides = slideshow.getSlides(), els = el[0].children;
for (var i = 1; i < slides.length; i++) {
slide = slides[i];
if (slide.properties.continued === "true" || slide.properties.count === "false") {
els[i - 1].className += ' has-continuation';
}
}
var s = d.createElement("style");
s.type = "text/css"; s.innerHTML = "@media print { .has-continuation { display: none; } }";
d.head.appendChild(s);
})(document);
// delete the temporary CSS (for displaying all slides initially) when the user
// starts to view slides
(function() {
var deleted = false;
slideshow.on('beforeShowSlide', function(slide) {
if (deleted) return;
var sheets = document.styleSheets, node;
for (var i = 0; i < sheets.length; i++) {
node = sheets[i].ownerNode;
if (node.dataset["target"] !== "print-only") continue;
node.parentNode.removeChild(node);
}
deleted = true;
});
})();
(function() {
"use strict"
// Replace <script> tags in slides area to make them executable
var scripts = document.querySelectorAll(
'.remark-slides-area .remark-slide-container script'
);
if (!scripts.length) return;
for (var i = 0; i < scripts.length; i++) {
var s = document.createElement('script');
var code = document.createTextNode(scripts[i].textContent);
s.appendChild(code);
var scriptAttrs = scripts[i].attributes;
for (var j = 0; j < scriptAttrs.length; j++) {
s.setAttribute(scriptAttrs[j].name, scriptAttrs[j].value);
}
scripts[i].parentElement.replaceChild(s, scripts[i]);
}
})();
(function() {
var links = document.getElementsByTagName('a');
for (var i = 0; i < links.length; i++) {
if (/^(https?:)?\/\//.test(links[i].getAttribute('href'))) {
links[i].target = '_blank';
}
}
})();
// adds .remark-code-has-line-highlighted class to <pre> parent elements
// of code chunks containing highlighted lines with class .remark-code-line-highlighted
(function(d) {
const hlines = d.querySelectorAll('.remark-code-line-highlighted');
const preParents = [];
const findPreParent = function(line, p = 0) {
if (p > 1) return null; // traverse up no further than grandparent
const el = line.parentElement;
return el.tagName === "PRE" ? el : findPreParent(el, ++p);
};
for (let line of hlines) {
let pre = findPreParent(line);
if (pre && !preParents.includes(pre)) preParents.push(pre);
}
preParents.forEach(p => p.classList.add("remark-code-has-line-highlighted"));
})(document);</script>
<script>
slideshow._releaseMath = function(el) {
var i, text, code, codes = el.getElementsByTagName('code');
for (i = 0; i < codes.length;) {
code = codes[i];
if (code.parentNode.tagName !== 'PRE' && code.childElementCount === 0) {
text = code.textContent;
if (/^\\\((.|\s)+\\\)$/.test(text) || /^\\\[(.|\s)+\\\]$/.test(text) ||
/^\$\$(.|\s)+\$\$$/.test(text) ||
/^\\begin\{([^}]+)\}(.|\s)+\\end\{[^}]+\}$/.test(text)) {
code.outerHTML = code.innerHTML; // remove <code></code>
continue;
}
}
i++;
}
};
slideshow._releaseMath(document);
</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-MML-AM_CHTML';
if (location.protocol !== 'file:' && /^https?:/.test(script.src))
script.src = script.src.replace(/^https?:/, '');
document.getElementsByTagName('head')[0].appendChild(script);
})();
</script>
</body>
</html>