forked from datacarpentry/R-genomics
-
Notifications
You must be signed in to change notification settings - Fork 5
/
CONTRIBUTING.html
441 lines (369 loc) · 15.6 KB
/
CONTRIBUTING.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
<!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></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/bootstrap.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 src="site_libs/navigation-1.1/tabsets.js"></script>
<link href="site_libs/font-awesome-4.5.0/css/font-awesome.min.css" rel="stylesheet" />
<style type="text/css">code{white-space: pre;}</style>
<style type="text/css">
table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode {
margin: 0; padding: 0; vertical-align: baseline; border: none; }
table.sourceCode { width: 100%; line-height: 100%; }
td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; }
td.sourceCode { padding-left: 5px; }
code > span.kw { color: #007020; font-weight: bold; }
code > span.dt { color: #902000; }
code > span.dv { color: #40a070; }
code > span.bn { color: #40a070; }
code > span.fl { color: #40a070; }
code > span.ch { color: #4070a0; }
code > span.st { color: #4070a0; }
code > span.co { color: #60a0b0; font-style: italic; }
code > span.ot { color: #007020; }
code > span.al { color: #ff0000; font-weight: bold; }
code > span.fu { color: #06287e; }
code > span.er { color: #ff0000; font-weight: bold; }
</style>
<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="style.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;
}
button.code-folding-btn:focus {
outline: none;
}
</style>
<style type="text/css">
/* padding for bootstrap navbar */
body {
padding-top: 51px;
padding-bottom: 40px;
}
/* offset scroll position for anchor links (for fixed navbar) */
.section h1 {
padding-top: 56px;
margin-top: -56px;
}
.section h2 {
padding-top: 56px;
margin-top: -56px;
}
.section h3 {
padding-top: 56px;
margin-top: -56px;
}
.section h4 {
padding-top: 56px;
margin-top: -56px;
}
.section h5 {
padding-top: 56px;
margin-top: -56px;
}
.section h6 {
padding-top: 56px;
margin-top: -56px;
}
</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>
$(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 = false;
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.90em;
padding-left: 25px;
text-indent: 0;
}
.tocify .list-group-item {
border-radius: 0px;
}
.tocify-subheader {
display: inline;
}
.tocify-subheader .tocify-item {
font-size: 0.95em;
}
</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"></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="00-before-we-start.html">Before we start</a>
</li>
<li>
<a href="01-intro-to-R.html">Intro to R</a>
</li>
<li>
<a href="02-starting-with-data.html">Starting with data</a>
</li>
<li>
<a href="03-data-frames.html">Data frames</a>
</li>
<li>
<a href="04-dplyr.html">The dplyr package</a>
</li>
<li>
<a href="05-data-visualization.html">Data visualization</a>
</li>
</ul>
<ul class="nav navbar-nav navbar-right">
<li>
<a href="https://github.com/data-lessons/R-genomics">
<span class="fa fa-github fa-lg"></span>
</a>
</li>
</ul>
</div><!--/.nav-collapse -->
</div><!--/.container -->
</div><!--/.navbar -->
<div class="fluid-row" id="header">
</div>
<div id="contributing" class="section level1">
<h1>Contributing</h1>
<p><a href="http://datacarpentry.org">Data Carpentry</a> in an open source project, and we welcome contributions of all kinds: new lessons, fixes to existing material, bug reports, and reviews of proposed changes are all welcome.</p>
<div id="contributor-agreement" class="section level2">
<h2>Contributor Agreement</h2>
<p>By contributing, you agree that we may redistribute your work under <a href="http://www.datacarpentry.org/R-ecology-lesson/LICENSE.html">our license</a>. In exchange, we will address your issues and/or assess your change proposal as promptly as we can, and help you become a member of our community. Everyone involved in <a href="https://software-carpentry.org">Software Carpentry</a> and <a href="http://datacarpentry.org">Data Carpentry</a> agrees to abide by our <a href="http://www.datacarpentry.org/R-ecology-lesson/CONDUCT.html">code of conduct</a>.</p>
</div>
<div id="working-with-github" class="section level2">
<h2>Working With GitHub</h2>
<p><strong>NOTE: this repository uses <code>gh-pages</code> as our default branch.</strong></p>
<ol style="list-style-type: decimal">
<li><p>Fork the <code>datacarpentry/R-ecology-lesson</code> repository on GitHub. <em>See the “Fork” button in the top-right corner of the screen on the GitHub website.</em></p></li>
<li><p>Clone that repository to your own machine. (It is also possible to make minor edits right on GitHub.) <em>At your terminal:</em></p>
<pre class="sourceCode bash"><code class="sourceCode bash"><span class="kw">git</span> clone https://github.com/your_username/R-ecology-lesson.git R-ecology-lesson
<span class="kw">cd</span> R-ecology-lesson
<span class="kw">git</span> remote add upstream https://github.com/datacarpentry/R-ecology-lesson.git</code></pre></li>
<li><p>Create a branch from <code>gh-pages</code> for your changes. Give your branch a meaningful name, such as <code>fix-typos-dplyr-lesson</code> or <code>add-tutorial-on-visualization</code>. <em>At your terminal:</em></p>
<pre class="sourceCode bash"><code class="sourceCode bash"><span class="kw">git</span> checkout -b fix-typos-dplyr-lesson</code></pre></li>
<li><p>Make your changes to the Rmd file. If you’d like to check the rendered version of your changes, you can do one of three things:</p>
<ul>
<li>if you have <code>GNU Make</code> installed on your system, type <code>make</code> at your shell terminal.</li>
<li>if you use RStudio, click on the “Knit” button in the top-right corner of your editor pane.</li>
<li>in other cases, you can type: <code>rmarkdown::render_site("01-intro-to-r.Rmd")</code> in your R terminal (make sure your working directory is at the root of the lesson) to generate the corresponding html file.</li>
</ul></li>
<li><p>Commit the Rmd file you edited (<code>git add file-you-changed.Rmd</code>, followed by <code>git commit -m "fix typos in dplyr lesson"</code>), and push your changes to your repository on GitHub (<code>git push origin fix-typos-dplyr-lesson</code>). If your change affects a lesson, <strong>please only commit and push the <code>Rmd</code> files</strong>. The rendered versions will be generated by the lesson maintainers to avoid merge conflicts.</p></li>
<li><p>Send a pull request (PR) to the <code>gh-pages</code> branch of the <code>datacarpentry/R-ecology-lesson</code> repository for this lesson at <a href="http://github.com/datacarpentry/R-ecology-lesson" class="uri">http://github.com/datacarpentry/R-ecology-lesson</a></p></li>
</ol>
<p>If it is easier for you to send edits to us some other way, please mail us at <a href="mailto:board@datacarpentry.org"><a href="mailto:board@datacarpentry.org">board@datacarpentry.org</a></a>. Given a choice between you creating content or wrestling with Git, we’d rather have you doing the former.</p>
</div>
<div id="file-locations-and-formats" class="section level2">
<h2>File Locations and Formats</h2>
<p>Each lesson is composed of files such as <code>00-before-we-start.Rmd</code>, <code>01-intro-to-r.Rmd</code> and so on. (We use two digits followed by a topic key to ensure files appear in the right order when listed.)</p>
<p>For the R material, lessons must be written in RMarkdown (ending in <code>Rmd</code>). A Makefile converts the Rmd files into HTML that are processed by Jekyll (the tool GitHub uses to create websites) as explained in <a href="https://github.com/datacarpentry/R-ecology-lesson#readme">the README file</a>.</p>
<p><em>Important Note:</em> We use the <code>purl()</code> function from <code>knitr</code> to generate a skeleton file that contains code to be distributed to the workshop participants. This strategy is useful in particular for error-prone pieces of code (e.g., if it contains long URLs). To take full advantage, every line of code that should be included in the handout <strong>must</strong> be enclosed in an <code>R</code> code chunk with <code>purl=TRUE</code> in the chunk options. Further, to aid students’ use of the handout code, consider including explanatory comments. When writing Challenges in particular, you may need to include redundant comments and used the chunk option <code>echo=FALSE</code>. In doubt consult the <code>Rmd</code> files for examples.</p>
<p>Images (e.g., screenshots) go into the <code>img/</code> folder. Graphics generated by some R code also go into this folder and get the prefix <code>R-ecology-</code>. This latter case is handled automatically with some knitr options in the <code>setup.R</code> file.</p>
<p>Raw data go into <code>data/</code>. However, at this stage, this folder is created programmatically and only contain dataset downloaded directly from the figshare repository. In other words, it can be safely be deleted (e.g. using <code>make clean-data</code> or <code>make clean</code>.)</p>
<p>The <code>data_output/</code> folder only contains data generated/exported by R code.</p>
<p>The <code>site_libs</code> folder is generated by the <strong>rmarkdown</strong> package and holds the javascript, css, and fonts used by the website.</p>
</div>
<div id="datasets" class="section level2">
<h2>Datasets</h2>
<p>We don’t store data for lessons inside the lesson repositories. For completed lessons the data should be publicly available in a data repository appropriate to the data type. For lesson development the data may be provided in any way that is convenient including posting to a website, on <a href="http://figshare.com/">figshare</a>, a public Dropbox link, a <a href="https://gist.github.com">GitHub gist</a>, or even included in the pull request (PR). Once the PR is ready to merge the data should be placed in the <a href="https://dx.doi.org/10.6084/m9.figshare.1314459.v5">official data repository</a> and all links to the data updated.</p>
</div>
<div id="formatting-of-the-material" class="section level2">
<h2>Formatting of the material</h2>
<p>To ensure a consistent formatting of the lessons, we recommend the following guidelines:</p>
<ul>
<li>No trailing white space</li>
<li>Wrap lines at 80 characters (unless it breaks URLs)</li>
<li>Use consistent capitalization (e.g., R not r, RStudio not rstudio or Rstudio)</li>
<li>Function names are written as <code>function()</code> while variables packages are written as <code>variable</code>, and package names as <strong><code>package</code></strong>.</li>
<li>Use unclosed atx style headers (see below):</li>
</ul>
<pre><code>## Use this format for headers
And not this format
-------------------</code></pre>
</div>
<div id="faq" class="section level2">
<h2>FAQ</h2>
<ul>
<li><em>Where can I get help?</em> <br/> Mail us at <a href="mailto:board@datacarpentry.org"><a href="mailto:board@datacarpentry.org">board@datacarpentry.org</a></a> or come chat with us on <a href="https://gitter.im/data-carpentry/Lobby">our Gitter chat</a>.</li>
</ul>
</div>
</div>
<hr/>
<p><a href="http://datacarpentry.org/">Data Carpentry</a>,
2017. <a href="LICENSE.html">License</a>. <a href="CONTRIBUTING.html">Contributing</a>. <br/>
Questions? Feedback?
Please <a href="https://github.com/datacarpentry/R-ecology-lesson/issues/new">file
an issue on GitHub</a>. <br/> On
Twitter: <a href="https://twitter.com/datacarpentry">@datacarpentry</a></p>
</div>
</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>