forked from cis-ds/course-site
-
Notifications
You must be signed in to change notification settings - Fork 0
/
hw00_homework_guidelines.html
483 lines (410 loc) · 18.3 KB
/
hw00_homework_guidelines.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
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
<!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>General Homework Guidelines</title>
<script src="site_libs/jquery-1.11.3/jquery.min.js"></script>
<meta name="viewport" content="width=device-width, initial-scale=1" />
<link href="site_libs/bootstrap-3.3.5/css/readable.min.css" rel="stylesheet" />
<script src="site_libs/bootstrap-3.3.5/js/bootstrap.min.js"></script>
<script src="site_libs/bootstrap-3.3.5/shim/html5shiv.min.js"></script>
<script src="site_libs/bootstrap-3.3.5/shim/respond.min.js"></script>
<script src="site_libs/jqueryui-1.11.4/jquery-ui.min.js"></script>
<link href="site_libs/tocify-1.9.1/jquery.tocify.css" rel="stylesheet" />
<script src="site_libs/tocify-1.9.1/jquery.tocify.js"></script>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-45631879-2', 'auto');
ga('send', 'pageview');
</script>
<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>
</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;
}
button.code-folding-btn:focus {
outline: none;
}
</style>
<style type="text/css">
/* padding for bootstrap navbar */
body {
padding-top: 66px;
padding-bottom: 40px;
}
/* offset scroll position for anchor links (for fixed navbar) */
.section h1 {
padding-top: 71px;
margin-top: -71px;
}
.section h2 {
padding-top: 71px;
margin-top: -71px;
}
.section h3 {
padding-top: 71px;
margin-top: -71px;
}
.section h4 {
padding-top: 71px;
margin-top: -71px;
}
.section h5 {
padding-top: 71px;
margin-top: -71px;
}
.section h6 {
padding-top: 71px;
margin-top: -71px;
}
</style>
<script>
// manage active state of menu based on current page
$(document).ready(function () {
// active menu anchor
href = window.location.pathname
href = href.substr(href.lastIndexOf('/') + 1)
if (href === "")
href = "index.html";
var menuAnchor = $('a[href="' + href + '"]');
// mark it active
menuAnchor.parent().addClass('active');
// if it's got a parent navbar menu mark it active as well
menuAnchor.closest('li.dropdown').addClass('active');
});
</script>
<div class="container-fluid main-container">
<!-- tabsets -->
<script src="site_libs/navigation-1.1/tabsets.js"></script>
<script>
$(document).ready(function () {
window.buildTabsets("TOC");
});
</script>
<!-- code folding -->
<script>
$(document).ready(function () {
// move toc-ignore selectors from section div to header
$('div.section.toc-ignore')
.removeClass('toc-ignore')
.children('h1,h2,h3,h4,h5').addClass('toc-ignore');
// establish options
var options = {
selectors: "h1,h2,h3",
theme: "bootstrap3",
context: '.toc-content',
hashGenerator: function (text) {
return text.replace(/[.\/?&!#<>]/g, '').replace(/\s/g, '_').toLowerCase();
},
ignoreSelector: ".toc-ignore",
scrollTo: 0
};
options.showAndHide = true;
options.smoothScroll = true;
// tocify
var toc = $("#TOC").tocify(options).data("toc-tocify");
});
</script>
<style type="text/css">
#TOC {
margin: 25px 0px 20px 0px;
}
@media (max-width: 768px) {
#TOC {
position: relative;
width: 100%;
}
}
.toc-content {
padding-left: 30px;
padding-right: 40px;
}
div.main-container {
max-width: 1200px;
}
div.tocify {
width: 20%;
max-width: 260px;
max-height: 85%;
}
@media (min-width: 768px) and (max-width: 991px) {
div.tocify {
width: 25%;
}
}
@media (max-width: 767px) {
div.tocify {
width: 100%;
max-width: none;
}
}
.tocify ul, .tocify li {
line-height: 20px;
}
.tocify-subheader .tocify-item {
font-size: 0.9em;
padding-left: 5px;
}
.tocify .list-group-item {
border-radius: 0px;
}
</style>
<!-- setup 3col/9col grid for toc_float and main content -->
<div class="row-fluid">
<div class="col-xs-12 col-sm-4 col-md-3">
<div id="TOC" class="tocify">
</div>
</div>
<div class="toc-content col-xs-12 col-sm-8 col-md-9">
<div class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html">Computing for the Social Sciences</a>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li>
<a href="index.html">Home</a>
</li>
<li>
<a href="faq.html">FAQ</a>
</li>
<li>
<a href="syllabus.html">Syllabus</a>
</li>
</ul>
<ul class="nav navbar-nav navbar-right">
</ul>
</div><!--/.nav-collapse -->
</div><!--/.container -->
</div><!--/.navbar -->
<div class="fluid-row" id="header">
<h1 class="title toc-ignore">General Homework Guidelines</h1>
</div>
<div id="github-prerequisites" class="section level1">
<h1>GitHub prerequisites</h1>
<p>I assume you can <a href="git07.html">pull from and push to GitHub from RStudio</a>.</p>
</div>
<div id="homework-workflow" class="section level1">
<h1>Homework workflow</h1>
<div class="figure">
<img src="images/homework_workflow.png" />
</div>
<p>Homework assignments will be stored in separate Git repositories under the <code>uc-cfss</code> organization on GitHub. To complete a homework assignment, you need to:</p>
<ol style="list-style-type: decimal">
<li><a href="https://guides.github.com/activities/forking/">Fork</a> the repository</li>
<li><a href="git05.html#step_2:_clone_the_new_github_repository_to_your_computer_via_rstudio">Clone</a> the repository to your computer</li>
<li>Modify the files and <a href="git05.html#step_3:_make_local_changes,_save,_commit">commit changes</a> to complete your solution.</li>
<li><a href="git05.html#step_4:_push_your_local_changes_online_to_github">Push</a>/sync the changes up to GitHub.</li>
<li><a href="https://help.github.com/articles/creating-a-pull-request">Create a pull request</a> on the original repository to turn in the assignment. <em>Make sure to include your name in the pull request.</em></li>
</ol>
</div>
<div id="authoring-markdown-files" class="section level1">
<h1>Authoring Markdown files</h1>
<p>Throughout this course, any basic text document should be written in <a href="http://daringfireball.net/projects/markdown/basics">Markdown</a> and should always have a filename that ends in <code>.md</code>. These files are pleasant to write and read, but are also easily converted into HTML and other output formats. GitHub provides an attractive HTML-like preview for Markdown documents. RStudio’s “Preview HTML” button will compile the open document to actual HTML and open a preview.</p>
<p>Whenever you are editing Markdown documents in RStudio, you can display a Markdown cheatsheet by going to Help > Markdown Quick Reference.</p>
</div>
<div id="authoring-r-markdown-files" class="section level1">
<h1>Authoring R Markdown files</h1>
<p>If your document is describing a data analysis, author it in <a href="http://rmarkdown.rstudio.com">R Markdown</a>, which is like Markdown, but with the addition of R “code chunks” that are runnable. The filename should end in <code>.Rmd</code> or <code>.rmd</code>. RStudio’s “Knit HTML” button will compile the open document to actual HTML and open a preview.</p>
<p>Whenever you are editing R Markdown documents in RStudio, you can display an R Markdown cheatsheet by going to Help > Cheatsheets > R Markdown Cheat Sheet. A basic introduction to R Markdown can also be found in <a href="http://r4ds.had.co.nz/r-markdown.html">R for Data Science</a></p>
</div>
<div id="which-files-to-commit" class="section level1">
<h1>Which files to commit</h1>
<ul>
<li>Always commit the main source document, e.g., the R script or R Markdown or Markdown document. Commit early, commit often!</li>
<li>For R Markdown source, also commit the intermediate Markdown (<code>.md</code>) file and any accompaying files, such as figures.
<ul>
<li>Some purists would say intermediate and downstream products do NOT belong in the repo. After all, you can always recreate them from source, right? But here in reality, it turns out to be incredibly handy to have this in the repo.</li>
</ul></li>
<li>Commit the end product HTML (<code>.html</code>) file.
<ul>
<li>See above comment re: version control purists vs. pragmatists.</li>
</ul></li>
<li>You may not want to commit the Markdown and HTML until the work is fairly advanced, maybe even until submission. Once these enter the repo, you really should recompile them each time you commit changes to the R Markdown source, so that the Git history reflects the way these files should evolve as an ensemble.</li>
<li><strong>Never ever</strong> edit the intermediate/output documents “by hand”. Only edit the source and then regenerate the downstream products from that.</li>
</ul>
</div>
<div id="make-your-work-shine" class="section level1">
<h1>Make your work shine!</h1>
<p>Here are some minor tweaks that can make a big difference in how awesome your product is.</p>
<div id="make-it-easy-for-people-to-access-your-work" class="section level2">
<h2>Make it easy for people to access your work</h2>
<p>Reduce the friction for graders to get the hard-working source code (the R markdown) <strong>and</strong> the front-facing report (HTML).</p>
<ul>
<li>Create a <code>README.md</code> in the homework’s main directory to serve as the landing page for your submission. Whenever anyone visits this repo, this will be automatically rendered nicely! In particular, hyperlinks will work.</li>
<li>With this <code>README.md</code> file, create annotated links to the documents graders will need to access. Such as:
<ul>
<li>Your main R Markdown document.</li>
<li>The intermediate Markdown product that comes from knitting your main R Markdown document. Remember GitHub will render this into pseudo-HTML automagically. Remember the figures in <code>figures/</code> need to be available in the repo in order appear here.</li>
<li>The final pretty HTML report. Read instructions below on how access the pretty, not the ugly source.</li>
</ul></li>
</ul>
<div id="linking-to-html-files-in-the-repo" class="section level3">
<h3>Linking to HTML files in the repo</h3>
<p>Simply visiting an HTML file in a GitHub repo just shows ugly HTML source. You need to do a little extra work to see this rendered as a proper webpage.</p>
<ul>
<li>Navigate to the HTML file on GitHub. Click on “Raw” to get the raw version; the URL should look something like this: <code>https://raw.github.com/uc-cfss/uc-cfss.github.io/hw00_homework_guidelines.html</code>. Copy that URL!</li>
<li>Create a link to that in the usual Markdown way BUT prepend <code>http://htmlpreview.github.io/?</code> to the URL. So the URL in your link should look something like this: <code>http://htmlpreview.github.io/?https://github.com/uc-cfss/uc-cfss.github.io/blob/master/hw00_homework_guidelines.html</code>. You can learn more about this preview facility <a href="http://htmlpreview.github.io">here</a>.</li>
<li>This sort of link would be fabulous to include in <code>README.md</code>.</li>
</ul>
</div>
</div>
<div id="make-it-easy-for-others-to-run-your-code" class="section level2">
<h2>Make it easy for others to run your code</h2>
<ul>
<li>In exactly one, very early R chunk, load any necessary packages, so your dependencies are obvious.</li>
<li>In exactly one, very early R chunk, import anything coming from an external file. This will make it easy for someone to see which data files are required, edit to reflect their locals paths if necessary, etc. There are situations where you might not keep data in the repo itself.</li>
<li>In exactly one, very last R chunk, report your session information. This prints version information about R, the operating system, and loaded packages so the reader knows the state of your machine when you rendered the R Markdown document.<a href="#fn1" class="footnoteRef" id="fnref1"><sup>1</sup></a> An R chunk with <code>devtools::session_info()</code> will produce something that looks like this:</li>
</ul>
<pre><code>## Session info --------------------------------------------------------------</code></pre>
<pre><code>## setting value
## version R version 3.3.1 (2016-06-21)
## system x86_64, darwin13.4.0
## ui X11
## language (EN)
## collate en_US.UTF-8
## tz America/Chicago
## date 2016-11-28</code></pre>
<pre><code>## Packages ------------------------------------------------------------------</code></pre>
<pre><code>## package * version date source
## assertthat 0.1 2013-12-06 CRAN (R 3.3.0)
## backports 1.0.4 2016-10-24 CRAN (R 3.3.0)
## colorspace 1.2-7 2016-10-11 CRAN (R 3.3.0)
## config 0.2 2016-08-02 CRAN (R 3.3.0)
## DBI 0.5-1 2016-09-10 CRAN (R 3.3.0)
## devtools 1.12.0 2016-06-24 CRAN (R 3.3.0)
## digest 0.6.10 2016-08-02 CRAN (R 3.3.0)
## dplyr * 0.5.0 2016-06-24 CRAN (R 3.3.0)
## evaluate 0.10 2016-10-11 CRAN (R 3.3.0)
## gapminder * 0.2.0 2015-12-31 CRAN (R 3.3.0)
## ggplot2 * 2.2.0 2016-11-10 Github (hadley/ggplot2@f442f32)
## gtable 0.2.0 2016-02-26 CRAN (R 3.3.0)
## htmltools 0.3.5 2016-03-21 CRAN (R 3.3.0)
## knitr 1.15 2016-11-09 CRAN (R 3.3.1)
## lazyeval 0.2.0 2016-06-12 CRAN (R 3.3.0)
## magrittr 1.5 2014-11-22 CRAN (R 3.3.0)
## memoise 1.0.0 2016-01-29 CRAN (R 3.3.0)
## munsell 0.4.3 2016-02-13 CRAN (R 3.3.0)
## nycflights13 0.2.0 2016-04-30 CRAN (R 3.3.0)
## plyr 1.8.4 2016-06-08 CRAN (R 3.3.0)
## purrr * 0.2.2 2016-06-18 CRAN (R 3.3.0)
## R6 2.2.0 2016-10-05 CRAN (R 3.3.0)
## rappdirs 0.3.1 2016-03-28 CRAN (R 3.3.0)
## Rcpp 0.12.7 2016-09-05 cran (@0.12.7)
## readr * 1.0.0 2016-08-03 CRAN (R 3.3.0)
## rmarkdown 1.1 2016-10-16 CRAN (R 3.3.1)
## rprojroot 1.1 2016-10-29 CRAN (R 3.3.0)
## scales 0.4.1 2016-11-09 CRAN (R 3.3.1)
## sparklyr * 0.4.31 2016-11-19 Github (rstudio/sparklyr@2662da5)
## stringi 1.1.2 2016-10-01 CRAN (R 3.3.0)
## stringr * 1.1.0 2016-08-19 cran (@1.1.0)
## tibble * 1.2 2016-08-26 cran (@1.2)
## tidyr * 0.6.0 2016-08-12 CRAN (R 3.3.0)
## tidyverse * 1.0.0 2016-09-09 CRAN (R 3.3.0)
## titanic * 0.1.0 2015-08-31 CRAN (R 3.3.0)
## withr 1.0.2 2016-06-20 CRAN (R 3.3.0)
## yaml 2.1.13 2014-06-12 CRAN (R 3.3.0)</code></pre>
<ul>
<li>Pretend you are someone else. Clone a fresh copy of your own repo from GitHub, fire up a new RStudio session and try to knit your R markdown file. Does it “just work”? It should!</li>
</ul>
</div>
<div id="make-pretty-tables" class="section level2">
<h2>Make pretty tables</h2>
<p>Instead of just printing an object with R, you could format the info in an attractive table. Some leads:</p>
<ul>
<li>The <code>kable()</code> function from <code>knitr</code>.</li>
<li>Also look into the packages <code>xtable</code>, <code>pander</code>.</li>
</ul>
<blockquote class="twitter-tweet" data-lang="en">
<p lang="en" dir="ltr">
Not sure what <a href="https://twitter.com/hashtag/rstats?src=hash">#rstats</a> package to use to make your lovely Reproducible Table? I made a flowchart for you! <a href="https://twitter.com/hashtag/knitr?src=hash">#knitr</a> <a href="http://t.co/5qC5EBADN4">pic.twitter.com/5qC5EBADN4</a>
</p>
— Andrew MacDonald (<span class="citation">@polesasunder</span>) <a href="https://twitter.com/polesasunder/status/464132152347475968">May 7, 2014</a>
</blockquote>
<script async src="//platform.twitter.com/widgets.js" charset="utf-8"></script>
<div id="acknowledgments" class="section level3 toc-ignore">
<h3>Acknowledgments</h3>
<ul>
<li>This page is derived in part from <a href="http://stat545.com">“UBC STAT 545A and 547M”</a>, licensed under the <a href="https://creativecommons.org/licenses/by-nc/3.0/">CC BY-NC 3.0 Creative Commons License</a>.</li>
</ul>
</div>
</div>
</div>
<div class="footnotes">
<hr />
<ol>
<li id="fn1"><p>Unfortunately I know of no easy way to generate similar information using Python.<a href="#fnref1">↩</a></p></li>
</ol>
</div>
<p>This work is licensed under the <a href="http://creativecommons.org/licenses/by-nc/4.0/">CC BY-NC 4.0 Creative Commons License</a>.</p>
</div>
</div>
</div>
<script>
// add bootstrap table styles to pandoc tables
$(document).ready(function () {
$('tr.header').parent('thead').parent('table').addClass('table table-condensed');
});
</script>
<!-- dynamically load mathjax for compatibility with self-contained -->
<script>
(function () {
var script = document.createElement("script");
script.type = "text/javascript";
script.src = "https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML";
document.getElementsByTagName("head")[0].appendChild(script);
})();
</script>
</body>
</html>