<?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 14:22 --> <meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1" /> <title>COVID-19 PubSeq Uploading Data (part 3)</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> <link rel="Blog stylesheet" type="text/css" href="blog.css" /> <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">COVID-19 PubSeq Uploading Data (part 3)</h1> <div id="table-of-contents"> <h2>Table of Contents</h2> <div id="text-table-of-contents"> <ul> <li><a href="#orgb5456df">1. Uploading Data</a></li> <li><a href="#org5b96fa9">2. Introduction</a></li> <li><a href="#orga21edf3">3. Step 1: Upload sequence</a></li> <li><a href="#orga03c092">4. Step 2: Add metadata</a> <ul> <li><a href="#org2ab94ef">4.1. Obligatory fields</a> <ul> <li><a href="#org9972a05">4.1.1. Sample ID (sample<sub>id</sub>)</a></li> <li><a href="#orgf4992bb">4.1.2. Collection date</a></li> <li><a href="#org2f55ae7">4.1.3. Collection location</a></li> <li><a href="#orgb10db8a">4.1.4. Sequencing technology</a></li> <li><a href="#orgf846ffe">4.1.5. Authors</a></li> </ul> </li> <li><a href="#org2056637">4.2. Optional fields</a> <ul> <li><a href="#orgb2348b1">4.2.1. Host information</a></li> <li><a href="#orgd963089">4.2.2. Collecting institution</a></li> <li><a href="#org3257813">4.2.3. Specimen source</a></li> <li><a href="#org8a596c8">4.2.4. Source database accession</a></li> <li><a href="#orgd1f5c90">4.2.5. Strain name</a></li> </ul> </li> </ul> </li> <li><a href="#orgb9edfdf">5. Step 3: Submit to COVID-19 PubSeq</a> <ul> <li><a href="#orgc929675">5.1. Trouble shooting</a></li> </ul> </li> </ul> </div> </div> <div id="outline-container-orgb5456df" class="outline-2"> <h2 id="orgb5456df"><span class="section-number-2">1</span> Uploading Data</h2> <div class="outline-text-2" id="text-1"> <p> <i>Work in progress!</i> </p> </div> </div> <div id="outline-container-org5b96fa9" class="outline-2"> <h2 id="org5b96fa9"><span class="section-number-2">2</span> Introduction</h2> <div class="outline-text-2" id="text-2"> <p> The COVID-19 PubSeq allows you to upload your SARS-Cov-2 strains to a public resource for global comparisons. Compute it triggered on upload. Read the <a href="./about">ABOUT</a> page for more information. </p> </div> </div> <div id="outline-container-orga21edf3" class="outline-2"> <h2 id="orga21edf3"><span class="section-number-2">3</span> Step 1: Upload sequence</h2> <div class="outline-text-2" id="text-3"> <p> To upload a sequence in the <a href="http://covid19.genenetwork.org/">web upload page</a> hit the browse button and select the FASTA file on your local hard disk. </p> <p> We start with an assembled or mapped sequence in FASTA format. The PubSeq uploader contains a <a href="https://github.com/arvados/bh20-seq-resource/blob/master/bh20sequploader/qc_fasta.py">QC step</a> which checks whether it is a likely SARS-CoV-2 sequence. While PubSeq deduplicates sequences and never overwrites metadata, you may still want to check whether your data already is in the system by querying some metadata as described in <a href="./blog?id=using-covid-19-pubseq-part1">Query metadata with SPARQL</a> or by simply downloading and checking one of the files on the <a href="./download">download</a> page. We find GenBank <a href="https://www.ncbi.nlm.nih.gov/nuccore/MT536190">MT536190.1</a> has not been included yet. A FASTA text file can be <a href="https://www.ncbi.nlm.nih.gov/nuccore/MT536190.1?report=fasta&log$=seqview&format=text">downloaded</a> to your local disk and uploaded through our <a href="./">web upload page</a>. Make sure the file does not include any HTML! </p> <p> Note: we currently only allow FASTA uploads. In the near future we'll allow for uploading raw sequence files. This is important for creating an improved pangenome. </p> </div> </div> <div id="outline-container-orga03c092" class="outline-2"> <h2 id="orga03c092"><span class="section-number-2">4</span> Step 2: Add metadata</h2> <div class="outline-text-2" id="text-4"> <p> The <a href="./">web upload page</a> contains fields for adding metadata. Metadata is not only important for attribution, is also important for analysis. The metadata is available for queries, see <a href="./blog?id=using-covid-19-pubseq-part1">Query metadata with SPARQL</a>, and can be used to annotate variations of the virus in different ways. </p> <p> A number of fields are obligatory: sample id, date, location, technology and authors. The others are optional, but it is valuable to enter them when information is available. Metadata is defined in this <a href="https://github.com/arvados/bh20-seq-resource/blob/master/bh20sequploader/bh20seq-schema.yml">schema</a>. From this schema we generate the input form. Note that opitional fields have a question mark in the <code>type</code>. You can add metadata yourself, btw, because this is a public resource! See also <a href="./blog?id=using-covid-19-pubseq-part5">Modify metadata</a> for more information. </p> <p> To get more information about a field click on the question mark on the web form. Here we add some extra information. </p> </div> <div id="outline-container-org2ab94ef" class="outline-3"> <h3 id="org2ab94ef"><span class="section-number-3">4.1</span> Obligatory fields</h3> <div class="outline-text-3" id="text-4-1"> </div> <div id="outline-container-org9972a05" class="outline-4"> <h4 id="org9972a05"><span class="section-number-4">4.1.1</span> Sample ID (sample<sub>id</sub>)</h4> <div class="outline-text-4" id="text-4-1-1"> <p> This is a string field that defines a unique sample identifier by the submitter. In addition to sample<sub>id</sub> we also have host<sub>id</sub>, provider<sub>sample</sub><sub>id</sub> and submitter<sub>sample</sub><sub>id</sub> where host is the host the sample came from, provider sample is the institution sample id and submitter is the submitting individual id. host<sub>id</sub> is important when multiple sequences come from the same host. Make sure not to have spaces in the sample<sub>id</sub>. </p> <p> Here we add the GenBank ID MT536190.1. </p> </div> </div> <div id="outline-container-orgf4992bb" class="outline-4"> <h4 id="orgf4992bb"><span class="section-number-4">4.1.2</span> Collection date</h4> <div class="outline-text-4" id="text-4-1-2"> <p> Estimated collection date. The GenBank page says April 6, 2020. </p> </div> </div> <div id="outline-container-org2f55ae7" class="outline-4"> <h4 id="org2f55ae7"><span class="section-number-4">4.1.3</span> Collection location</h4> <div class="outline-text-4" id="text-4-1-3"> <p> A search on wikidata says Los Angelos is <a href="https://www.wikidata.org/entity/Q65">https://www.wikidata.org/entity/Q65</a> </p> </div> </div> <div id="outline-container-orgb10db8a" class="outline-4"> <h4 id="orgb10db8a"><span class="section-number-4">4.1.4</span> Sequencing technology</h4> <div class="outline-text-4" id="text-4-1-4"> <p> GenBank entry says Illumina, so we can fill that in </p> </div> </div> <div id="outline-container-orgf846ffe" class="outline-4"> <h4 id="orgf846ffe"><span class="section-number-4">4.1.5</span> Authors</h4> <div class="outline-text-4" id="text-4-1-5"> <p> GenBank entry says 'Lamers,S., Nolan,D.J., Rose,R., Cross,S., Moraga Amador,D., Yang,T., Caruso,L., Navia,W., Von Borstel,L., Hui Zhou,X., Freehan,A. and Garcia-Diaz,J.', so we can fill that in. </p> </div> </div> </div> <div id="outline-container-org2056637" class="outline-3"> <h3 id="org2056637"><span class="section-number-3">4.2</span> Optional fields</h3> <div class="outline-text-3" id="text-4-2"> <p> All other fields are optional. But let's see what we can add. </p> </div> <div id="outline-container-orgb2348b1" class="outline-4"> <h4 id="orgb2348b1"><span class="section-number-4">4.2.1</span> Host information</h4> <div class="outline-text-4" id="text-4-2-1"> <p> Sadly, not much is known about the host from GenBank. A little sleuthing renders an interesting paper by some of the authors titled <a href="https://www.medrxiv.org/content/10.1101/2020.04.24.20078691v1">SARS-CoV-2 is consistent across multiple samples and methodologies</a> which dates after the sample, but has no reference other than that the raw data came from the SRA database, so it probably does not describe this particular sample. We don't know what this strain of SARS-Cov-2 did to the person and what the person was like (say age group). </p> </div> </div> <div id="outline-container-orgd963089" class="outline-4"> <h4 id="orgd963089"><span class="section-number-4">4.2.2</span> Collecting institution</h4> <div class="outline-text-4" id="text-4-2-2"> <p> We can fill that in. </p> </div> </div> <div id="outline-container-org3257813" class="outline-4"> <h4 id="org3257813"><span class="section-number-4">4.2.3</span> Specimen source</h4> <div class="outline-text-4" id="text-4-2-3"> <p> We have that: nasopharyngeal swab </p> </div> </div> <div id="outline-container-org8a596c8" class="outline-4"> <h4 id="org8a596c8"><span class="section-number-4">4.2.4</span> Source database accession</h4> <div class="outline-text-4" id="text-4-2-4"> <p> Genbank which is <a href="http://identifiers.org/insdc/MT536190.1#sequence">http://identifiers.org/insdc/MT536190.1#sequence</a>. Note we plug in our own identifier MT536190.1. </p> </div> </div> <div id="outline-container-orgd1f5c90" class="outline-4"> <h4 id="orgd1f5c90"><span class="section-number-4">4.2.5</span> Strain name</h4> <div class="outline-text-4" id="text-4-2-5"> <p> SARS-CoV-2/human/USA/LA-BIE-070/2020 </p> </div> </div> </div> </div> <div id="outline-container-orgb9edfdf" class="outline-2"> <h2 id="orgb9edfdf"><span class="section-number-2">5</span> Step 3: Submit to COVID-19 PubSeq</h2> <div class="outline-text-2" id="text-5"> <p> Once you have the sequence and the metadata together, hit the 'Add to Pangenome' button. The data will be checked, submitted and the workflows should kick in! </p> </div> <div id="outline-container-orgc929675" class="outline-3"> <h3 id="orgc929675"><span class="section-number-3">5.1</span> Trouble shooting</h3> <div class="outline-text-3" id="text-5-1"> <p> We got an error saying: {"stem": "<a href="http://www.wikidata.org/entity/">http://www.wikidata.org/entity/</a>",… which means that our location field was not formed correctly! After fixing it to look like <a href="http://www.wikidata.org/entity/Q65">http://www.wikidata.org/entity/Q65</a> (note http instead on https and entity instead of wiki) the submission went through. Reload the page (it won't empty the fields) to re-enable the submit button. </p> </div> </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 14:22</small>. </div> </body> </html>