From 264be797c55aaff6eb9639d5a15d9081e2256253 Mon Sep 17 00:00:00 2001 From: Pjotr Prins Date: Sat, 30 May 2020 18:13:48 -0500 Subject: BLOG --- doc/blog/using-covid-19-pubseq-part3.html | 296 ++++++++++++++++++++---------- 1 file changed, 204 insertions(+), 92 deletions(-) (limited to 'doc/blog/using-covid-19-pubseq-part3.html') diff --git a/doc/blog/using-covid-19-pubseq-part3.html b/doc/blog/using-covid-19-pubseq-part3.html index 4132784..91879b0 100644 --- a/doc/blog/using-covid-19-pubseq-part3.html +++ b/doc/blog/using-covid-19-pubseq-part3.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - + COVID-19 PubSeq Uploading Data (part 3) @@ -248,64 +248,62 @@ for the JavaScript code in this tag.

Table of Contents

-
-

1 Uploading Data

-
-

-Work in progress! -

-
-
-
-

2 Introduction

-
+ +
+

1 Uploading Data

+

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 ABOUT page for more information. +public resource for global comparisons. A recompute of the pangenome +gets triggered on upload. Read the ABOUT page for more information.

-
-

3 Step 1: Upload sequence

-
+
+

2 Step 1: Upload sequence

+

To upload a sequence in the web upload page hit the browse button and select the FASTA file on your local hard disk. @@ -332,9 +330,9 @@ an improved pangenome.

-
-

4 Step 2: Add metadata

-
+
+

3 Step 2: Add metadata

+

The web upload page contains fields for adding metadata. Metadata is not only important for attribution, is also important for @@ -348,7 +346,7 @@ 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 schema. From this schema we generate the input form. Note that -opitional fields have a question mark in the type. You can add +optional fields have a question mark in the type. You can add metadata yourself, btw, because this is a public resource! See also Modify metadata for more information.

@@ -359,13 +357,13 @@ the web form. Here we add some extra information.

-
-

4.1 Obligatory fields

-
+
+

3.1 Obligatory fields

+
-
-

4.1.1 Sample ID (sampleid)

-
+
+

3.1.1 Sample ID (sampleid)

+

This is a string field that defines a unique sample identifier by the submitter. In addition to sampleid we also have hostid, @@ -382,37 +380,37 @@ Here we add the GenBank ID MT536190.1.

-
-

4.1.2 Collection date

-
+
+

3.1.2 Collection date

+

Estimated collection date. The GenBank page says April 6, 2020.

-
-

4.1.3 Collection location

-
+
+

3.1.3 Collection location

+

-A search on wikidata says Los Angelos is +A search on wikidata says Los Angeles is https://www.wikidata.org/entity/Q65

-
-

4.1.4 Sequencing technology

-
+
+

3.1.4 Sequencing technology

+

GenBank entry says Illumina, so we can fill that in

-
-

4.1.5 Authors

-
+
+

3.1.5 Authors

+

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., @@ -422,17 +420,17 @@ Freehan,A. and Garcia-Diaz,J.', so we can fill that in.

-
-

4.2 Optional fields

-
+
+

3.2 Optional fields

+

All other fields are optional. But let's see what we can add.

-
-

4.2.1 Host information

-
+
+

3.2.1 Host information

+

Sadly, not much is known about the host from GenBank. A little sleuthing renders an interesting paper by some of the authors titled @@ -445,27 +443,27 @@ did to the person and what the person was like (say age group).

-
-

4.2.2 Collecting institution

-
+
+

3.2.2 Collecting institution

+

We can fill that in.

-
-

4.2.3 Specimen source

-
+
+

3.2.3 Specimen source

+

We have that: nasopharyngeal swab

-
-

4.2.4 Source database accession

-
+
+

3.2.4 Source database accession

+

Genbank which is http://identifiers.org/insdc/MT536190.1#sequence. Note we plug in our own identifier MT536190.1. @@ -473,9 +471,9 @@ Note we plug in our own identifier MT536190.1.

-
-

4.2.5 Strain name

-
+
+

3.2.5 Strain name

+

SARS-CoV-2/human/USA/LA-BIE-070/2020

@@ -484,20 +482,36 @@ SARS-CoV-2/human/USA/LA-BIE-070/2020
-
-

5 Step 3: Submit to COVID-19 PubSeq

-
+
+

4 Step 3: Submit to COVID-19 PubSeq

+

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!

+ + +
+

4.1 Trouble shooting

+
+

+We got an error saying: {"stem": "http://www.wikidata.org/entity/",… +which means that our location field was not formed correctly! After +fixing it to look like http://www.wikidata.org/entity/Q65 (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. +

+
+
-
-

6 Step 4: Check output

-
+ +
+

5 Step 4: Check output

+

The current pipeline takes 5.5 hours to complete! Once it completes the updated data can be checked on the DOWNLOAD page. After completion @@ -505,24 +519,122 @@ of above output this +

6 Bulk sequence uploader

+
+

+Above steps require a manual upload of one sequence with metadata. +What if you have a number of sequences you want to upload in bulk? +For this we have a command line version of the uploader that can +directly submit to COVID-19 PubSeq. It accepts a FASTA sequence +file an associated metadata in YAML format. The YAML matches +the web form and gets validated from the same schema looks. The YAML +that you need to create/generate for your samples looks like +

+ +
+
id: placeholder
+
+host:
+    host_id: XX1
+    host_species: http://purl.obolibrary.org/obo/NCBITaxon_9606
+    host_sex: http://purl.obolibrary.org/obo/PATO_0000384
+    host_age: 20
+    host_age_unit: http://purl.obolibrary.org/obo/UO_0000036
+    host_health_status: http://purl.obolibrary.org/obo/NCIT_C25269
+    host_treatment: Process in which the act is intended to modify or alter host status (Compounds)
+    host_vaccination: [vaccines1,vaccine2]
+    ethnicity: http://purl.obolibrary.org/obo/HANCESTRO_0010
+    additional_host_information: Optional free text field for additional information
+
+sample:
+    sample_id: Id of the sample as defined by the submitter
+    collector_name: Name of the person that took the sample
+    collecting_institution: Institute that was responsible of sampling
+    specimen_source: [http://purl.obolibrary.org/obo/NCIT_C155831,http://purl.obolibrary.org/obo/NCIT_C155835]
+    collection_date: "2020-01-01"
+    collection_location: http://www.wikidata.org/entity/Q148
+    sample_storage_conditions: frozen specimen
+    source_database_accession: [http://identifiers.org/insdc/LC522350.1#sequence]
+    additional_collection_information: Optional free text field for additional information
+
+virus:
+    virus_species: http://purl.obolibrary.org/obo/NCBITaxon_2697049
+    virus_strain: SARS-CoV-2/human/CHN/HS_8/2020
+
+technology:
+    sample_sequencing_technology: [http://www.ebi.ac.uk/efo/EFO_0009173,http://www.ebi.ac.uk/efo/EFO_0009173]
+    sequence_assembly_method: Protocol used for assembly
+    sequencing_coverage: [70.0, 100.0]
+    additional_technology_information: Optional free text field for additional information
+
+submitter:
+    authors: [John Doe, Joe Boe, Jonny Oe]
+    submitter_name: [John Doe]
+    submitter_address: John Doe's address
+    originating_lab: John Doe kitchen
+    lab_address: John Doe's address
+    provider_sample_id: XXX1
+    submitter_sample_id: XXX2
+    publication: PMID00001113
+    submitter_orcid: [https://orcid.org/0000-0000-0000-0000,https://orcid.org/0000-0000-0000-0001]
+    additional_submitter_information: Optional free text field for additional information
+
+
+
-
-

6.1 Trouble shooting

+
+

6.1 Run the uploader (CLI)

-We got an error saying: {"stem": "http://www.wikidata.org/entity/",… -which means that our location field was not formed correctly! After -fixing it to look like http://www.wikidata.org/entity/Q65 (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. +Installing with pip you should be +able to run +

+ +
+bh20sequploader sequence.fasta metadata.yaml
+
+ + + +

+Alternatively the script can be installed from github. Run on the +command line +

+ +
+python3 bh20sequploader/main.py example/sequence.fasta example/maximum_metadata_example.yaml
+
+ + +

+after installing dependencies (also described in INSTALL with the GNU +Guix package manager). +

+ +

+The web interface using this exact same script so it should just work +(TM). +

+
+
+ +
+

6.2 Example: uploading bulk GenBank sequences

+
+

+We also use above script to bulk upload GenBank sequences with a FASTA +and YAML extractor specific for GenBank. This means that the steps we +took above for uploading a GenBank sequence are already automated.

-
Created by Pjotr Prins (pjotr.public768 at thebird 'dot' nl) using Emacs org-mode and a healthy dose of Lisp!
Modified 2020-05-30 Sat 10:44
. +
Created by Pjotr Prins (pjotr.public768 at thebird 'dot' nl) using Emacs org-mode and a healthy dose of Lisp!
Modified 2020-05-30 Sat 18:12
.
-- cgit v1.2.3