forked from kylesezhi/lintr-presentation
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
executable file
·349 lines (303 loc) · 10.5 KB
/
index.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
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>LintR</title>
<meta name="description" content="A framework for easily creating beautiful presentations using HTML">
<meta name="author" content="Hakim El Hattab">
<meta name="apple-mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-status-bar-style" content="black-translucent">
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no">
<link rel="stylesheet" href="css/reveal.css">
<link rel="stylesheet" href="css/theme/moon.css" id="theme">
<!-- Theme used for syntax highlighting of code -->
<link rel="stylesheet" href="lib/css/zenburn.css">
<!-- Printing and PDF exports -->
<script>
var link = document.createElement( 'link' );
link.rel = 'stylesheet';
link.type = 'text/css';
link.href = window.location.search.match( /print-pdf/gi ) ? 'css/print/pdf.css' : 'css/print/paper.css';
document.getElementsByTagName( 'head' )[0].appendChild( link );
</script>
<!--[if lt IE 9]>
<script src="lib/js/html5shiv.js"></script>
<![endif]-->
</head>
<body>
<div class="reveal">
<!-- Any section element inside of this container is displayed as a slide -->
<div class="slides">
<section>
<h1>lintR for the Learner</h1>
<h3>An Overview to Linting in R</h3>
<p>
<small><a href="mailto:[email protected]">Kyle Bedell</a> / <a href="http://twitter.com/kylesezhi">@kylesezhi</a></small>
</p>
</section>
<section>
<h2>Who Am I?</h2>
<p>
<ul>
<li class="fragment">Web Developer</li>
<li class="fragment">Japan enthusiast</li>
<li class="fragment">Newcomer to R</li>
</ul>
</p>
</section>
<section>
<h2>Today's Talk</h2>
<p>
<ol>
<li class="fragment">Coding style FTW</span></li>
<li class="fragment">R style matters</span></li>
<li class="fragment">Linting R</span></li>
<li class="fragment">Reformatting R</span></li>
</ol>
<p class="fragment"><a href="https://github.com/kylesezhi/lintr-presentation">https://github.com/kylesezhi/lintr-presentation</a></p>
</p>
</section>
<section data-background="https://media.giphy.com/media/3ornk57KwDXf81rjWM/giphy.gif">
</section>
<section>
<h2>Meet your neighbors</h2>
<p style="color:white;">Share:
<ul style="color:white;">
<li class="fragment">Your name</li>
<li class="fragment">Why you like R</li>
<li class="fragment">Something you think is cool</li>
<li class="fragment">Etcetera</li>
</ul>
</p>
</section>
<section>
<section>
<h2>What is code style?</h2>
<span class="fragment">
<p>Wikipedia says:</p>
<blockquote cite="https://en.wikipedia.org/wiki/Programming_style">
“Programming style is a set of rules or guidelines used when writing the source code for a computer program.”
</blockquote>
</span>
</section>
<section data-background="https://media.giphy.com/media/bqalUGFYfyHzW/giphy.gif">
</section>
<section>
<h2>Why should we care about R style?</h2>
<p class="fragment">Decide with the folks around you</p>
</section>
<section>
<h2>What did you talk about?</h2>
</section>
</section>
<section>
<section>
<h2>I care about code style because</h2>
<ul>
<li class="fragment">Write understandable code</li>
<li class="fragment">Avoid logic errors</li>
<li class="fragment">Learn new languages correctly</li>
</ul>
<aside class="notes">
This is for you in the future, too!
</aside>
</section>
<section>
<blockquote>
“Always code as if the guy who ends up maintaining your code will be a <u>violent psychopath who knows where you live</u>.”
</blockquote>
</section>
</section>
<section>
<h2>R code comparison</h2>
<p class="fragment">Which is more <u>readable</u>?</p>
<aside class="notes">
Please remember i am a noob and be kind if you have questions.
</aside>
</section>
<section>
<section>
<span class="fragment"><pre><code class="hljs" data-trim>
system.time(expr2 = rnorm(10e5))
</code></pre></span>
<span class="fragment"><pre><code class="hljs" data-trim>
system.time(expr1 <- rnorm(10e5))
</code></pre></span>
<aside class="notes">
The first is an error because = is argument passing in that context!
</aside>
</section>
<section>
<span class="fragment"><pre><code class="hljs" data-trim>
x[x<-1]
</code></pre></span>
<span class="fragment"><pre><code class="hljs" data-trim>
x[x < -1]
</code></pre></span>
<aside class="notes">
x is 1. Whoops! We want all x es less than -1.
</aside>
</section>
<section>
<span class="fragment"><pre><code class="hljs" data-trim>
x <- 1 : 10
base :: get
</code></pre></span>
<span class="fragment"><pre><code class="hljs" data-trim>
x <- 1:10
base::get
</code></pre></span>
<aside class="notes">
x is 1. Whoops! We want all x es less than -1.
</aside>
</section>
<section>
<span class="fragment"><pre><code class="hljs" data-trim>
if(x < 5)
{
y}
else {
x}
</code></pre></span>
<span class="fragment"><pre><code class="hljs" data-trim>
if(x < 5)
x else
y
</code></pre></span>
<span class="fragment"><pre><code class="hljs" data-trim>
if (x < 5){
x
} else {
y
}
</code></pre></span>
<aside class="notes">
The first will fail.
</aside>
</section>
<section>
<span class="fragment"><pre><code class="hljs" data-trim>
if (is.null(ylim)) ylim <- c(0, 0.06)
</code></pre></span>
<span class="fragment"><pre><code class="hljs" data-trim>
if (is.null(ylim))
ylim <- c(0, 0.06)
</code></pre></span>
<span class="fragment"><pre><code class="hljs" data-trim>
if (is.null(ylim)) {
ylim <- c(0, 0.06)
}
</code></pre></span>
<aside class="notes">
The first will fail.
</aside>
</section>
<section>
<span class="fragment"><pre><code class="hljs" data-trim>
PredictCTR <- function(query, property, num.days, show.plot =
TRUE)
</code></pre></span>
<span class="fragment"><pre><code class="hljs" data-trim>
PredictCTR <- function(query, property, num.days,
show.plot = TRUE)
</code></pre></span>
<aside class="notes">
The first will fail.
</aside>
</section>
</section>
<section>
<h2>Good code style</h2>
<ul>
<li class="fragment">Reduces logic errors</li>
<li class="fragment">Improves readability</li>
</ul>
</section>
<section data-background="https://media.giphy.com/media/sWIHPcLkmxDby/giphy.gif">
<h1 class="fragment">Is there one style to rule them all?</h1>
</section>
<section data-background="https://media.giphy.com/media/QIPEV0HWAiXVm/giphy.gif">
</section>
<section>
<h2>Great places to start</h2>
<p class="fragment"><a href="https://google.github.io/styleguide/Rguide.xml">Google's R Style Guide</a></p>
<p class="fragment"><a href="http://adv-r.had.co.nz/Style.html">Hadley Wickham's Style Guide</a></p>
<p class="fragment">Plus your own! (you do have one, right?)</p>
</section>
<section>
<h2>Encourage good style</h2>
<p class="fragment">Let the computer help</p>
<p class="fragment">Use a linter for static code analysis fun</p>
</section>
<section>
<h2>Lintr</h2>
<ul>
<li class="fragment">Syntax errors</li>
<li class="fragment">Style</li>
<li class="fragment">Can do <a href="https://github.com/jimhester/lintr#available-linters">lots of things</a></li>
<li class="fragment">Works on <a href="https://github.com/jimhester/lintr#rstudio">your favorite text editor / IDE</a></li>
</ul>
</section>
<section>
<h1>DEMO</h1>
</section>
<section>
<h2>Don't like the defaults?</h2>
<p class="fragment">Configure it with a <a href="https://github.com/jimhester/lintr#project-configuration">standard config file</a></p>
<p class="fragment">Hack it or make your own new linter!</p>
</section>
<section>
<h2>Getting to know new code?</h2>
<p class="fragment">Turn on lintr and go to town!</p>
<p class="fragment">This is a great way to learn <a href="https://github.com/trending/r">a new codebase</a>.</p>
</section>
<section>
<h2>You mean I need to do all those changes manually?</h2>
</section>
<section data-background="https://media.giphy.com/media/bqalUGFYfyHzW/giphy.gif">
</section>
<section>
<h2>Let the computer help</h2>
<p class="fragment">Use a formatter for automated formatting</p>
</section>
<section>
<h2>FormatR</h2>
<ul>
<li class="fragment">Standardize line lengths</li>
<li class="fragment">Standardize indentation</li>
<li class="fragment">Replace = with <-</li>
<li class="fragment">And <a href="https://yihui.name/formatr/#2-reformat-r-code">much more</a></li>
</ul>
</section>
<section>
<h1>DEMO</h1>
</section>
<section>
<h2>Thank you</h2>
<p class="fragment"><a href="https://github.com/kylesezhi/lintr-presentation">https://github.com/kylesezhi/lintr-presentation</a></p>
</section>
</div>
</div>
<script src="lib/js/head.min.js"></script>
<script src="js/reveal.js"></script>
<script>
// More info https://github.com/hakimel/reveal.js#configuration
Reveal.initialize({
controls: true,
progress: true,
history: true,
center: true,
transition: 'slide', // none/fade/slide/convex/concave/zoom
// More info https://github.com/hakimel/reveal.js#dependencies
dependencies: [
{ src: 'lib/js/classList.js', condition: function() { return !document.body.classList; } },
{ src: 'plugin/markdown/marked.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } },
{ src: 'plugin/markdown/markdown.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } },
{ src: 'plugin/highlight/highlight.js', async: true, callback: function() { r.initHighlightingOnLoad(); } },
{ src: 'plugin/zoom-js/zoom.js', async: true },
{ src: 'plugin/notes/notes.js', async: true }
]
});
</script>
</body>
</html>