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
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
|
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<!-- 2020-05-29 Fri 08:27 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>About/FAQ</title>
<meta name="generator" content="Org mode" />
<meta name="author" content="Pjotr Prins" />
<style type="text/css">
<!--/*--><![CDATA[/*><!--*/
.title { text-align: center;
margin-bottom: .2em; }
.subtitle { text-align: center;
font-size: medium;
font-weight: bold;
margin-top:0; }
.todo { font-family: monospace; color: red; }
.done { font-family: monospace; color: green; }
.priority { font-family: monospace; color: orange; }
.tag { background-color: #eee; font-family: monospace;
padding: 2px; font-size: 80%; font-weight: normal; }
.timestamp { color: #bebebe; }
.timestamp-kwd { color: #5f9ea0; }
.org-right { margin-left: auto; margin-right: 0px; text-align: right; }
.org-left { margin-left: 0px; margin-right: auto; text-align: left; }
.org-center { margin-left: auto; margin-right: auto; text-align: center; }
.underline { text-decoration: underline; }
#postamble p, #preamble p { font-size: 90%; margin: .2em; }
p.verse { margin-left: 3%; }
pre {
border: 1px solid #ccc;
box-shadow: 3px 3px 3px #eee;
padding: 8pt;
font-family: monospace;
overflow: auto;
margin: 1.2em;
}
pre.src {
position: relative;
overflow: visible;
padding-top: 1.2em;
}
pre.src:before {
display: none;
position: absolute;
background-color: white;
top: -10px;
right: 10px;
padding: 3px;
border: 1px solid black;
}
pre.src:hover:before { display: inline;}
/* Languages per Org manual */
pre.src-asymptote:before { content: 'Asymptote'; }
pre.src-awk:before { content: 'Awk'; }
pre.src-C:before { content: 'C'; }
/* pre.src-C++ doesn't work in CSS */
pre.src-clojure:before { content: 'Clojure'; }
pre.src-css:before { content: 'CSS'; }
pre.src-D:before { content: 'D'; }
pre.src-ditaa:before { content: 'ditaa'; }
pre.src-dot:before { content: 'Graphviz'; }
pre.src-calc:before { content: 'Emacs Calc'; }
pre.src-emacs-lisp:before { content: 'Emacs Lisp'; }
pre.src-fortran:before { content: 'Fortran'; }
pre.src-gnuplot:before { content: 'gnuplot'; }
pre.src-haskell:before { content: 'Haskell'; }
pre.src-hledger:before { content: 'hledger'; }
pre.src-java:before { content: 'Java'; }
pre.src-js:before { content: 'Javascript'; }
pre.src-latex:before { content: 'LaTeX'; }
pre.src-ledger:before { content: 'Ledger'; }
pre.src-lisp:before { content: 'Lisp'; }
pre.src-lilypond:before { content: 'Lilypond'; }
pre.src-lua:before { content: 'Lua'; }
pre.src-matlab:before { content: 'MATLAB'; }
pre.src-mscgen:before { content: 'Mscgen'; }
pre.src-ocaml:before { content: 'Objective Caml'; }
pre.src-octave:before { content: 'Octave'; }
pre.src-org:before { content: 'Org mode'; }
pre.src-oz:before { content: 'OZ'; }
pre.src-plantuml:before { content: 'Plantuml'; }
pre.src-processing:before { content: 'Processing.js'; }
pre.src-python:before { content: 'Python'; }
pre.src-R:before { content: 'R'; }
pre.src-ruby:before { content: 'Ruby'; }
pre.src-sass:before { content: 'Sass'; }
pre.src-scheme:before { content: 'Scheme'; }
pre.src-screen:before { content: 'Gnu Screen'; }
pre.src-sed:before { content: 'Sed'; }
pre.src-sh:before { content: 'shell'; }
pre.src-sql:before { content: 'SQL'; }
pre.src-sqlite:before { content: 'SQLite'; }
/* additional languages in org.el's org-babel-load-languages alist */
pre.src-forth:before { content: 'Forth'; }
pre.src-io:before { content: 'IO'; }
pre.src-J:before { content: 'J'; }
pre.src-makefile:before { content: 'Makefile'; }
pre.src-maxima:before { content: 'Maxima'; }
pre.src-perl:before { content: 'Perl'; }
pre.src-picolisp:before { content: 'Pico Lisp'; }
pre.src-scala:before { content: 'Scala'; }
pre.src-shell:before { content: 'Shell Script'; }
pre.src-ebnf2ps:before { content: 'ebfn2ps'; }
/* additional language identifiers per "defun org-babel-execute"
in ob-*.el */
pre.src-cpp:before { content: 'C++'; }
pre.src-abc:before { content: 'ABC'; }
pre.src-coq:before { content: 'Coq'; }
pre.src-groovy:before { content: 'Groovy'; }
/* additional language identifiers from org-babel-shell-names in
ob-shell.el: ob-shell is the only babel language using a lambda to put
the execution function name together. */
pre.src-bash:before { content: 'bash'; }
pre.src-csh:before { content: 'csh'; }
pre.src-ash:before { content: 'ash'; }
pre.src-dash:before { content: 'dash'; }
pre.src-ksh:before { content: 'ksh'; }
pre.src-mksh:before { content: 'mksh'; }
pre.src-posh:before { content: 'posh'; }
/* Additional Emacs modes also supported by the LaTeX listings package */
pre.src-ada:before { content: 'Ada'; }
pre.src-asm:before { content: 'Assembler'; }
pre.src-caml:before { content: 'Caml'; }
pre.src-delphi:before { content: 'Delphi'; }
pre.src-html:before { content: 'HTML'; }
pre.src-idl:before { content: 'IDL'; }
pre.src-mercury:before { content: 'Mercury'; }
pre.src-metapost:before { content: 'MetaPost'; }
pre.src-modula-2:before { content: 'Modula-2'; }
pre.src-pascal:before { content: 'Pascal'; }
pre.src-ps:before { content: 'PostScript'; }
pre.src-prolog:before { content: 'Prolog'; }
pre.src-simula:before { content: 'Simula'; }
pre.src-tcl:before { content: 'tcl'; }
pre.src-tex:before { content: 'TeX'; }
pre.src-plain-tex:before { content: 'Plain TeX'; }
pre.src-verilog:before { content: 'Verilog'; }
pre.src-vhdl:before { content: 'VHDL'; }
pre.src-xml:before { content: 'XML'; }
pre.src-nxml:before { content: 'XML'; }
/* add a generic configuration mode; LaTeX export needs an additional
(add-to-list 'org-latex-listings-langs '(conf " ")) in .emacs */
pre.src-conf:before { content: 'Configuration File'; }
table { border-collapse:collapse; }
caption.t-above { caption-side: top; }
caption.t-bottom { caption-side: bottom; }
td, th { vertical-align:top; }
th.org-right { text-align: center; }
th.org-left { text-align: center; }
th.org-center { text-align: center; }
td.org-right { text-align: right; }
td.org-left { text-align: left; }
td.org-center { text-align: center; }
dt { font-weight: bold; }
.footpara { display: inline; }
.footdef { margin-bottom: 1em; }
.figure { padding: 1em; }
.figure p { text-align: center; }
.equation-container {
display: table;
text-align: center;
width: 100%;
}
.equation {
vertical-align: middle;
}
.equation-label {
display: table-cell;
text-align: right;
vertical-align: middle;
}
.inlinetask {
padding: 10px;
border: 2px solid gray;
margin: 10px;
background: #ffffcc;
}
#org-div-home-and-up
{ text-align: right; font-size: 70%; white-space: nowrap; }
textarea { overflow-x: auto; }
.linenr { font-size: smaller }
.code-highlighted { background-color: #ffff00; }
.org-info-js_info-navigation { border-style: none; }
#org-info-js_console-label
{ font-size: 10px; font-weight: bold; white-space: nowrap; }
.org-info-js_search-highlight
{ background-color: #ffff00; color: #000000; font-weight: bold; }
.org-svg { width: 90%; }
/*]]>*/-->
</style>
<script type="text/javascript">
/*
@licstart The following is the entire license notice for the
JavaScript code in this tag.
Copyright (C) 2012-2020 Free Software Foundation, Inc.
The JavaScript code in this tag is free software: you can
redistribute it and/or modify it under the terms of the GNU
General Public License (GNU GPL) as published by the Free Software
Foundation, either version 3 of the License, or (at your option)
any later version. The code is distributed WITHOUT ANY WARRANTY;
without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU GPL for more details.
As additional permission under GNU GPL version 3 section 7, you
may distribute non-source (e.g., minimized or compacted) forms of
that code without the copy of the GNU GPL normally required by
section 4, provided you include this license notice and a URL
through which recipients can access the Corresponding Source.
@licend The above is the entire license notice
for the JavaScript code in this tag.
*/
<!--/*--><![CDATA[/*><!--*/
function CodeHighlightOn(elem, id)
{
var target = document.getElementById(id);
if(null != target) {
elem.cacheClassElem = elem.className;
elem.cacheClassTarget = target.className;
target.className = "code-highlighted";
elem.className = "code-highlighted";
}
}
function CodeHighlightOff(elem, id)
{
var target = document.getElementById(id);
if(elem.cacheClassElem)
elem.className = elem.cacheClassElem;
if(elem.cacheClassTarget)
target.className = elem.cacheClassTarget;
}
/*]]>*///-->
</script>
</head>
<body>
<div id="content">
<h1 class="title">About/FAQ</h1>
<div id="table-of-contents">
<h2>Table of Contents</h2>
<div id="text-table-of-contents">
<ul>
<li><a href="#org783b5e9">1. What is the 'public sequence resource' about?</a></li>
<li><a href="#org2c0bcfd">2. Who created the public sequence resource?</a></li>
<li><a href="#org34070d3">3. How does the public sequence resource compare to other data resources?</a></li>
<li><a href="#org64a9493">4. Why should I upload my data here?</a></li>
<li><a href="#orgf898e7f">5. Why should I not upload by data here?</a></li>
<li><a href="#org828e164">6. How does the public sequence resource work?</a></li>
<li><a href="#org7b0d03f">7. Who uses the public sequence resource?</a></li>
<li><a href="#org31aaf23">8. Is this about open data?</a></li>
<li><a href="#orgb376b6c">9. Is this about free software?</a></li>
<li><a href="#orgf19cd96">10. How do I upload raw data?</a></li>
<li><a href="#orgebfed00">11. How do I change metadata?</a></li>
<li><a href="#orge2aecf8">12. How do I change the work flows?</a></li>
<li><a href="#orgd45b3bc">13. How do I change the source code?</a></li>
<li><a href="#org2bb9455">14. Should I choose CC-BY or CC0?</a></li>
<li><a href="#org62bf23f">15. How do I deal with private data and privacy?</a></li>
<li><a href="#org40c6da0">16. How do I communicate with you?</a></li>
<li><a href="#org1f27c44">17. Who are the sponsors?</a></li>
</ul>
</div>
</div>
<div id="outline-container-org783b5e9" class="outline-2">
<h2 id="org783b5e9"><span class="section-number-2">1</span> What is the 'public sequence resource' about?</h2>
<div class="outline-text-2" id="text-1">
<p>
The <b>public sequence resource</b> aims to provide a generic and useful
resource for COVID-19 research. The focus is on providing the best
possible sequence data with associated metadata that can be used for
sequence comparison and protein prediction.
</p>
</div>
</div>
<div id="outline-container-org2c0bcfd" class="outline-2">
<h2 id="org2c0bcfd"><span class="section-number-2">2</span> Who created the public sequence resource?</h2>
<div class="outline-text-2" id="text-2">
<p>
The <b>public sequence resource</b> is an initiative by <a href="https://github.com/arvados/bh20-seq-resource/graphs/contributors">bioinformatics</a> and
ontology experts who want to create something agile and useful for the
wider research community. The initiative started at the COVID-19
biohackathon in April 2020 and is ongoing. The main project drivers
are Pjotr Prins (UTHSC), Peter Amstutz (Curii), Michael Crusoe (Common
Workflow Language), Thomas Liener (consultant, formerly EBI) and
Jerven Bolleman (Swiss Institute of Bioinformatics).
</p>
<p>
Notably, as this is a free software initiative, the project represents
major work by hundreds of software developers and ontology and data
wrangling experts. Thank you everyone!
</p>
</div>
</div>
<div id="outline-container-org34070d3" class="outline-2">
<h2 id="org34070d3"><span class="section-number-2">3</span> How does the public sequence resource compare to other data resources?</h2>
<div class="outline-text-2" id="text-3">
<p>
The short version is that we use state-of-the-art practices in
bioinformatics using agile methods. Unlike the resources from large
institutes we can improve things on a dime and anyone can contribute
to building out this resource!
</p>
<p>
Importantly: all data is published under the <a href="https://creativecommons.org/licenses/by/4.0/">Creative Commons 4.0
attribution license</a> which means it data can be published and workflows
can run in public environments allowing for improved access for
research and reproducible results. This contrasts with some other
public resources, including GISAID.
</p>
</div>
</div>
<div id="outline-container-org64a9493" class="outline-2">
<h2 id="org64a9493"><span class="section-number-2">4</span> Why should I upload my data here?</h2>
<div class="outline-text-2" id="text-4">
<ol class="org-ol">
<li>We champion truly shareable data without licensing restrictions - with proper
attribution</li>
<li>We provide full metadata support using state-of-the-art ontology's</li>
<li>We provide a web-based sequence uploader and a command-line version
for bulk uploads</li>
<li>We provide a live SPARQL end-point for all metadata</li>
<li>We provide free data analysis and sequence comparison triggered on data upload</li>
<li>We do real work for you, with this <a href="https://workbench.lugli.arvadosapi.com/container_requests/lugli-xvhdp-bhhk4nxx1lch5od">link</a> you can see the last
run took 5.5 hours!</li>
<li>We provide free downloads of all computed output</li>
<li>There is no need to set up pipelines and/or compute clusters</li>
<li>All workflows get triggered on uploading a new sequence</li>
<li>When someone (you?) improves the software/workflows and everyone benefits</li>
<li>Your data gets automatically integrated with the Swiss Institure of
Bioinformatics COVID-19 knowledge base
<a href="https://covid-19-sparql.expasy.org/">https://covid-19-sparql.expasy.org/</a> (Elixir Switzerland)</li>
<li>Your data will be used to develop drug targets</li>
</ol>
<p>
Finally, if you upload your data here we have workflows that output
formatted data suitable for uploading to EBI resources (and soon
others). Uploading your data here get your data ready for upload to
multiple resources.
</p>
</div>
</div>
<div id="outline-container-orgf898e7f" class="outline-2">
<h2 id="orgf898e7f"><span class="section-number-2">5</span> Why should I not upload by data here?</h2>
<div class="outline-text-2" id="text-5">
<p>
Funny question. There are only good reasons to upload your data here
and make it available to the widest audience possible.
</p>
<p>
In fact, you can upload your data here as well as to other
resources. It is your data after all. No one can prevent you from
uploading your data to multiple resources.
</p>
<p>
We recommend uploading to EBI and NCBI resources using our data
conversion tools. It means you only enter data once and make the
process smooth. You can also use our command line data uploader
for bulk uploads!
</p>
</div>
</div>
<div id="outline-container-org828e164" class="outline-2">
<h2 id="org828e164"><span class="section-number-2">6</span> How does the public sequence resource work?</h2>
<div class="outline-text-2" id="text-6">
<p>
On uploading a sequence with metadata it will automatically be
processed and incorporated into the public pangenome with metadata
using workflows from the High Performance Open Biology Lab defined
<a href="https://github.com/hpobio-lab/viral-analysis/tree/master/cwl/pangenome-generate">here</a>.
</p>
</div>
</div>
<div id="outline-container-org7b0d03f" class="outline-2">
<h2 id="org7b0d03f"><span class="section-number-2">7</span> Who uses the public sequence resource?</h2>
<div class="outline-text-2" id="text-7">
<p>
The Swiss Institute of Bioinformatics has included this data in
<a href="https://covid-19-sparql.expasy.org/">https://covid-19-sparql.expasy.org/</a> and made it part of <a href="https://www.uniprot.org/">Uniprot</a>.
</p>
<p>
<a href="https://uthsc.edu">UTHSC</a> and <a href="https://www.ornl.gov/news/ornl-fight-against-covid-19">ORNL</a> use COVID-19 PubSeq data for protein prediction and
drug development.
</p>
</div>
</div>
<div id="outline-container-org31aaf23" class="outline-2">
<h2 id="org31aaf23"><span class="section-number-2">8</span> Is this about open data?</h2>
<div class="outline-text-2" id="text-8">
<p>
All data is published under a <a href="https://creativecommons.org/licenses/by/4.0/">Creative Commons 4.0 attribution license</a>
(CC-BY-4.0). You can download the raw and published (GFA/RDF/FASTA)
data and store it for further processing.
</p>
</div>
</div>
<div id="outline-container-orgb376b6c" class="outline-2">
<h2 id="orgb376b6c"><span class="section-number-2">9</span> Is this about free software?</h2>
<div class="outline-text-2" id="text-9">
<p>
Absolutely. Free software allows for fully reproducible pipelines. You
can take our workflows and data and run it elsewhere!
</p>
</div>
</div>
<div id="outline-container-orgf19cd96" class="outline-2">
<h2 id="orgf19cd96"><span class="section-number-2">10</span> How do I upload raw data?</h2>
<div class="outline-text-2" id="text-10">
<p>
We are preparing raw sequence data pipelines (fastq and BAM). The
reason is that we want the best data possible for downstream analysis
(including protein prediction and test development). The current
approach where people publish final sequences of SARS-CoV-2 is lacking
because it hides how this sequence was created. For reasons of
reproducible and improved results we want/need to work with the raw
sequence reads (both short reads and long reads) and take alternative
assembly variations into consideration. This is all work in progress.
</p>
</div>
</div>
<div id="outline-container-orgebfed00" class="outline-2">
<h2 id="orgebfed00"><span class="section-number-2">11</span> How do I change metadata?</h2>
<div class="outline-text-2" id="text-11">
<p>
See the <a href="http://covid19.genenetwork.org/blog">http://covid19.genenetwork.org/blog</a>!
</p>
</div>
</div>
<div id="outline-container-orge2aecf8" class="outline-2">
<h2 id="orge2aecf8"><span class="section-number-2">12</span> How do I change the work flows?</h2>
<div class="outline-text-2" id="text-12">
<p>
See the <a href="http://covid19.genenetwork.org/blog">http://covid19.genenetwork.org/blog</a>!
</p>
</div>
</div>
<div id="outline-container-orgd45b3bc" class="outline-2">
<h2 id="orgd45b3bc"><span class="section-number-2">13</span> How do I change the source code?</h2>
<div class="outline-text-2" id="text-13">
<p>
Go to our <a href="https://github.com/arvados/bh20-seq-resource">source code repositories</a>, fork/clone the repository, change
something and submit a <a href="https://github.com/arvados/bh20-seq-resource/pulls">pull request</a> (PR). That easy! Check out how
many PRs we already merged.
</p>
</div>
</div>
<div id="outline-container-org2bb9455" class="outline-2">
<h2 id="org2bb9455"><span class="section-number-2">14</span> Should I choose CC-BY or CC0?</h2>
<div class="outline-text-2" id="text-14">
<p>
Restrictive data licenses are hampering data sharing and reproducible
research. CC0 is the preferred license because it gives researchers
the most freedom. Since we provide metadata there is no reason for
others not to honour your work. We also provide CC-BY as an option
because we know people like the attribution clause.
</p>
<p>
In all honesty: we prefer both data and software to be free.
</p>
</div>
</div>
<div id="outline-container-org62bf23f" class="outline-2">
<h2 id="org62bf23f"><span class="section-number-2">15</span> How do I deal with private data and privacy?</h2>
<div class="outline-text-2" id="text-15">
<p>
A public sequence resource is about public data. Metadata can refer to
private data. You can use your own (anonymous) identifiers. We also
plan to combine identifiers with clinical data stored securely at
<a href="https://redcap-covid19.elixir-luxembourg.org/redcap/">REDCap</a>. See the relevant <a href="https://github.com/arvados/bh20-seq-resource/issues/21">tracker</a> for more information and contributing.
</p>
</div>
</div>
<div id="outline-container-org40c6da0" class="outline-2">
<h2 id="org40c6da0"><span class="section-number-2">16</span> How do I communicate with you?</h2>
<div class="outline-text-2" id="text-16">
<p>
We use a <a href="https://gitter.im/arvados/pubseq?utm_source=share-link&utm_medium=link&utm_campaign=share-link">gitter channel</a> you can join.
</p>
</div>
</div>
<div id="outline-container-org1f27c44" class="outline-2">
<h2 id="org1f27c44"><span class="section-number-2">17</span> Who are the sponsors?</h2>
<div class="outline-text-2" id="text-17">
<p>
The main sponsors are listed in the footer. In addition to the time
generously donated by many contributors we also acknowledge Amazon AWS
for donating COVID-19 related compute time.
</p>
</div>
</div>
</div>
<div id="postamble" class="status">
<hr><small>Created by <a href="http://thebird.nl/">Pjotr Prins</a> (pjotr.public768 at thebird 'dot' nl) using Emacs org-mode and a healthy dose of Lisp!<br />Modified 2020-05-29 Fri 08:26</small>.
</div>
</body>
</html>
|
