-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathsession7C_talk1.html
More file actions
448 lines (336 loc) · 12.4 KB
/
session7C_talk1.html
File metadata and controls
448 lines (336 loc) · 12.4 KB
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
<!DOCTYPE html>
<html lang="" xml:lang="">
<head>
<title>autoharp</title>
<meta charset="utf-8" />
<meta name="author" content="Vik Gopal" />
<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" />
</head>
<body>
<textarea id="source">
class: center, middle, inverse, title-slide
# autoharp
### Vik Gopal
---
# Example Worksheet
.left-column[
<img src="user2021-autoharp_files/figure-html/unnamed-chunk-1-1.png" title="2-panel figure shows pdf and cdf of random variable" alt="2-panel figure shows pdf and cdf of random variable" width="110%" />
]
.right-column[
## Question
Write a function that simulates from the pdf
$$ f(x) = 4x^3 I(0 < x < 1) $$
Run the function to generate `\(10^4\)` random variates.
## Requirements
- A function named `rf( )`, with two arguments.
- A vector named `X` of length `1e4`.
]
---
class: middle
.pull-left[
## Problems We Faced
Students' code failed to run on our machines because of:
- logical errors,
- packages they used,
- objects wrongly named, or
- incorrect path settings.
]
--
.pull-right[
## Our Goals
We wanted a flexible framework to assess:
- correctness of output objects,
- run-time efficiency, and
- R coding expertise.
]
---
class: middle
<img src="instructor_overview.png" title="Desired workflow" alt="Desired workflow" width="75%" style="display: block; margin: auto;" />
---
# Testing Correctness Output
<img src="framework1-1a.png" title="Solution template is run to generate correct versions of objects and create a test script." alt="Solution template is run to generate correct versions of objects and create a test script." width="65%" style="display: block; margin: auto;" />
---
# Testing Correctness Output
<img src="framework1-1b.png" title="Student script is run to generate student versions of objects." alt="Student script is run to generate student versions of objects." width="65%" style="display: block; margin: auto;" />
---
# Testing Correctness Output
<img src="framework1-1c.png" title="Correct objects are copied to student environment" alt="Correct objects are copied to student environment" width="65%" style="display: block; margin: auto;" />
---
# Testing Correctness Output
<img src="framework1-1d.png" title="Test code is executed in student environment, thus checking student-created objects." alt="Test code is executed in student environment, thus checking student-created objects." width="65%" style="display: block; margin: auto;" />
---
# Run-time Statistics
<img src="tut1_runtime.png" title="Histograms of memory usage and run-time for a batch of worksheets" alt="Histograms of memory usage and run-time for a batch of worksheets" width="60%" style="display: block; margin: auto;" />
---
# Static Code Analysis
.pull-left[
<img src="user2021-autoharp_files/figure-html/unnamed-chunk-8-1.png" style="display: block; margin: auto;" />
]
.pull-right[
```r
rf <- function (n) {
x <- c ()
for (i in 1:n) {
x [i] <- (runif(1)/4)^(1/3)
}
return (x)
}
```
* `igraph` does the plotting.
]
---
# Static Code Analysis
.pull-left[
<img src="user2021-autoharp_files/figure-html/unnamed-chunk-10-1.png" style="display: block; margin: auto;" />
]
.pull-right[
```r
rf <- function (n) {
* x <- c ()
* for (i in 1:n) {
* x [i] <- (runif(1)/4)^(1/3)
}
return (x)
}
```
* This code has room for improvement.
]
---
# Static Code Analysis
.pull-left[
<img src="user2021-autoharp_files/figure-html/unnamed-chunk-12-1.png" style="display: block; margin: auto;" />
]
.pull-right[
<table>
<thead>
<tr>
<th style="text-align:right;"> id </th>
<th style="text-align:left;"> name </th>
<th style="text-align:left;"> call_status </th>
<th style="text-align:left;"> formal_arg </th>
<th style="text-align:right;"> depth </th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:right;"> 1 </td>
<td style="text-align:left;"> &lt;- </td>
<td style="text-align:left;"> TRUE </td>
<td style="text-align:left;"> FALSE </td>
<td style="text-align:right;"> 1 </td>
</tr>
<tr>
<td style="text-align:right;"> 2 </td>
<td style="text-align:left;"> rf </td>
<td style="text-align:left;"> FALSE </td>
<td style="text-align:left;"> FALSE </td>
<td style="text-align:right;"> 2 </td>
</tr>
<tr>
<td style="text-align:right;"> 3 </td>
<td style="text-align:left;"> function </td>
<td style="text-align:left;"> TRUE </td>
<td style="text-align:left;"> FALSE </td>
<td style="text-align:right;"> 2 </td>
</tr>
<tr>
<td style="text-align:right;"> 4 </td>
<td style="text-align:left;"> n </td>
<td style="text-align:left;"> FALSE </td>
<td style="text-align:left;"> TRUE </td>
<td style="text-align:right;"> 3 </td>
</tr>
<tr>
<td style="text-align:right;"> 5 </td>
<td style="text-align:left;"> { </td>
<td style="text-align:left;"> TRUE </td>
<td style="text-align:left;"> FALSE </td>
<td style="text-align:right;"> 3 </td>
</tr>
<tr>
<td style="text-align:right;"> 6 </td>
<td style="text-align:left;"> &lt;- </td>
<td style="text-align:left;"> TRUE </td>
<td style="text-align:left;"> FALSE </td>
<td style="text-align:right;"> 4 </td>
</tr>
</tbody>
</table>
<br>
* An R expression is stored as an S4 object.
* The `TreeHarp` object contains node type information.
* Tokenising allows for Natural Language techniques to be applied.
]
---
# Additional Functions
1. It's easy for students to make mistakes such as:
* slightly different names for objects.
* incorrect path settings.
1. `autoharp` provides a [shiny app](https://blog.nus.edu.sg/stavg/files/2021/06/soln_checker_v2.mp4) for students to run their code before submission.
2. The `autoharp` was developed for a class on visualisation in R, so
it contains a function to [generate thumbnails](https://blog.nus.edu.sg/stavg/files/2021/06/thumbnails_v2.mp4) of all the plots created.
---
# Desired Functionality
- Detecting areas for improvement in student scripts, e.g.
- duplicated chunks of code within a script.
- highlighting where piping, or an apply call could be used instead.
```r
x <- f1(w)
y <- f2 (x)
z <- f3(y)
```
- Diffs/Visualisations between data frames.
---
class: center, middle
### Is the `autoharp` the right package for me?
---
# Alternatives
1. The package helps in the way I create worksheet problems, and grade them.
* Students submit an entire script, which I run on my end.
1. There are alternative packages out there, e.g.:
* `markmyassignment`
* `homework`
* `learnr`, together with `grade_this`.
---
# Documentation & Contact Information
1. User manuals (and this deck of slides) can be found at
https://singator.github.io/autoharp-docs/
2. The `autoharp` ships with a couple of examples of solution templates and
student scripts that you can try out.
```r
list.files(system.file("examples", package="autoharp"))
```
```
## [1] "question_sheets" "soln_templates" "student_scripts"
```
2. Feel free to get in touch at **vik.gopal at nus.edu.sg** if you need to.
--
<br>
## Thank you for listening, stay safe and healthy!
---
class: center, middle
### P.S.: if you are wondering about the name...
It's the title of a song by Belgian band known as [Hooverphonic](https://www.hooverphonic.com/). I used to listen
to them a lot (Thanks Claudio!).
</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%",
"highlightLines": true
});
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>