path: root/doc/web/about.org

#+TITLE: About/FAQ
#+AUTHOR: Pjotr Prins

* Table of Contents                                                     :TOC:noexport:
 - [[#what-is-the-public-sequence-resource-about][What is the 'public sequence resource' about?]]
 - [[#presentations][Presentations]]
 - [[#who-created-the-public-sequence-resource][Who created the public sequence resource?]]
 - [[#how-does-the-public-sequence-resource-compare-to-other-data-resources][How does the public sequence resource compare to other data resources?]]
 - [[#why-should-i-upload-my-data-here][Why should I upload my data here?]]
 - [[#why-should-i-not-upload-by-data-here][Why should I not upload by data here?]]
 - [[#how-does-the-public-sequence-resource-work][How does the public sequence resource work?]]
 - [[#who-uses-the-public-sequence-resource][Who uses the public sequence resource?]]
 - [[#how-can-i-contribute][How can I contribute?]]
 - [[#is-this-about-open-data][Is this about open data?]]
 - [[#is-this-about-free-software][Is this about free software?]]
 - [[#how-do-i-upload-raw-data][How do I upload raw data?]]
 - [[#how-do-i-change-metadata][How do I change metadata?]]
 - [[#how-do-i-change-the-work-flows][How do I change the work flows?]]
 - [[#how-do-i-change-the-source-code][How do I change the source code?]]
 - [[#should-i-choose-cc-by-or-cc0][Should I choose CC-BY or CC0?]]
 - [[#are-there-also-variant-in-the-rdf-databases-][Are there also variant in the RDF databases? *]]
 - [[#how-do-i-deal-with-private-data-and-privacy][How do I deal with private data and privacy?]]
 - [[#do-you-have-any-checks-or-concerns-if-human-sequence-accidentally-submitted-to-your-service-as-part-of-a-fastq-][Do you have any checks or concerns if human sequence accidentally submitted to your service as part of a fastq? *]]
 - [[#does-pubseq-support-only-sars-cov-2-data-][Does PubSeq support only SARS-CoV-2 data? *]]
 - [[#how-do-i-communicate-with-you][How do I communicate with you?]]
 - [[#who-are-the-sponsors][Who are the sponsors?]]

* What is the 'public sequence resource' about?

The *public sequence resource* 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.

* Presentations

We presented at the BOSC 2020 Have a look at the [[https://bcc2020.sched.com/event/coLw][video]] ([[https://drive.google.com/file/d/1skXHwVKM_gl73-_4giYIOQ1IlC5X5uBo/view?usp=sharing][alternative
link]]) and the [[https://drive.google.com/file/d/1vyEgfvSqhM9yIwWZ6Iys-QxhxtVxPSdp/view?usp=sharing][poster]].

* Who created the public sequence resource?

The *public sequence resource* is an initiative by [[https://github.com/arvados/bh20-seq-resource/graphs/contributors][bioinformatics]] 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), Andrea Guarracino
(University of Rome Tor Vergata), Michael Crusoe (Common Workflow
Language), Thomas Liener (consultant, formerly EBI), Erik Garrison
(UCSC) and Jerven Bolleman (Swiss Institute of Bioinformatics).

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!

* How does the public sequence resource compare to other data resources?

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! Sequences from GenBank, EBI/ENA and
others are regularly added to PubSeq. We encourage people to everyone
to submit on PubSeq because of its superior live tooling and metadata
support (see the next question).

Importantly: all data is published under either the [[https://creativecommons.org/licenses/by/4.0/][Creative Commons
4.0 attribution license]] or the [[https://creativecommons.org/share-your-work/public-domain/cc0/][CC0 “No Rights Reserved” license]] 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,
such as GISAID.

* Why should I upload my data here?

1. We champion truly shareable data without licensing restrictions - with proper
   attribution
2. We provide full metadata support using state-of-the-art ontology's
2. We provide a web-based sequence uploader and a command-line version
   for bulk uploads
3. We provide a live SPARQL end-point for all metadata
2. We provide free data analysis and sequence comparison triggered on data upload
3. We do real work for you, with this [[https://workbench.lugli.arvadosapi.com/container_requests/lugli-xvhdp-bhhk4nxx1lch5od][link]] you can see the last
   run took 5.5 hours!
4. We provide free downloads of all computed output
3. There is no need to set up pipelines and/or compute clusters
4. All workflows get triggered on uploading a new sequence
4. When someone (you?) improves the software/workflows and everyone benefits
4. Your data gets automatically integrated with the Swiss Institure of
   Bioinformatics COVID-19 knowledge base
   https://covid-19-sparql.expasy.org/ (Elixir Switzerland)
4. Your data will be used to develop drug targets

Finally, if you upload your data here we have workflows that output
formatted data suitable for [[http://covid19.genenetwork.org/blog?id=using-covid-19-pubseq-part6][uploading to EBI resources]] (and soon
others). Uploading your data here get your data ready for upload to
multiple resources.

* Why should I not upload by data here?

Funny question.  There are only good reasons to upload your data here
and make it available to the widest audience possible.

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.

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!

* How does the public sequence resource work?

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
[[https://github.com/hpobio-lab/viral-analysis/tree/master/cwl/pangenome-generate][here]].

* Who uses the public sequence resource?

The Swiss Institute of Bioinformatics has included this data in
https://covid-19-sparql.expasy.org/ and made it part of [[https://www.uniprot.org/][Uniprot]].

The Pantograph [[https://graph-genome.github.io/][viewer]] uses PubSeq data for their visualisations.

[[https://uthsc.edu][UTHSC]] (USA), [[https://www.esr.cri.nz/][ESR]] (New Zealand) and [[https://www.ornl.gov/news/ornl-fight-against-covid-19][ORNL]] (USA) use COVID-19 PubSeq data
for monitoring, protein prediction and drug development.

* How can I contribute?

You can contribute by submitting sequences, updating metadata, submit
issues on our issue tracker, and more importantly add functionality.
See 'How do I change the source code' below. Read through our online
documentation at http://covid19.genenetwork.org/blog as a starting
point.

* Is this about open data?

All data is published under a [[https://creativecommons.org/licenses/by/4.0/][Creative Commons 4.0 attribution license]]
(CC-BY-4.0). You can download the raw and published (GFA/RDF/FASTA)
data and store it for further processing.

* Is this about free software?

Absolutely. Free software allows for fully reproducible pipelines. You
can take our workflows and data and run it elsewhere!

* How do I upload raw data?

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.

* How do I change metadata?

See the [[http://covid19.genenetwork.org/blog]]!

* How do I change the work flows?

Workflows are on [[https://github.com/arvados/bh20-seq-resource/tree/master/workflows][github]] and can be modified. See also the BLOG
[[http://covid19.genenetwork.org/blog]] on workflows.

* How do I change the source code?

Go to our [[https://github.com/arvados/bh20-seq-resource][source code repositories]], fork/clone the repository, change
something and submit a [[https://github.com/arvados/bh20-seq-resource/pulls][pull request]] (PR). That easy! Check out how
many PRs we already merged.

* Should I choose CC-BY or CC0?

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.

In all honesty: we prefer both data and software to be free.

* Are there also variant in the RDF databases? *

We do output a RDF file with the pangenome built in, and you can parse it because it has variants implicitly.

We are also writing tools to generate VCF files directly from the pangenome.

* How do I deal with private data and privacy?

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
[[https://redcap-covid19.elixir-luxembourg.org/redcap/][REDCap]]. See the relevant [[https://github.com/arvados/bh20-seq-resource/issues/21][tracker]] for more information and contributing.

* Do you have any checks or concerns if human sequence accidentally submitted to your service as part of a fastq? *

We are planning to remove reads that match the human reference.

* Does PubSeq support only SARS-CoV-2 data? *

To date, PubSeq is a resource specific to SARS-CoV-2, but we are designing it to be able to support other species in the future.


* How do I communicate with you?

We use a [[https://gitter.im/arvados/pubseq?utm_source=share-link&utm_medium=link&utm_campaign=share-link][gitter channel]] you can join.

* Who are the sponsors?

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.