Skip to content

Commit 9ca2178

Browse files
bedroesbbedroesb
authored
Merge pull request #111 from bedroesb/ena-submission
Start with adding a general ENA data submission toolbox landingpage
2 parents 7e41da9 + 92e1659 commit 9ca2178

File tree

6 files changed

+832
-11
lines changed

6 files changed

+832
-11
lines changed

‎_data/sidebars/main.yml

+11-9
Original file line numberDiff line numberDiff line change
@@ -76,13 +76,15 @@ subitems:
7676
url: /uniprot
7777
- title: ArrayExpress
7878
url: /arrayexpress
79-
- title: Covid-19 data submission
80-
url: /covid-19/
79+
- title: ENA data submission toolbox
80+
url: /ena-submission
8181
subitems:
82-
- title: SARS-CoV-2 raw reads submission in Galaxy
83-
url: /covid-19/sarscov2_submission
84-
- title: SARS-CoV-2 assembly submission in Galaxy
85-
url: /covid-19/sarscov2_assembly_submission
86-
- title: Frequently asked questions
87-
url: /covid-19/faq
88-
82+
- title: SARS-CoV-2 usecase
83+
url: /covid-19/
84+
subitems:
85+
- title: SARS-CoV-2 raw reads submission in Galaxy
86+
url: /covid-19/sarscov2_submission
87+
- title: SARS-CoV-2 assembly submission in Galaxy
88+
url: /covid-19/sarscov2_assembly_submission
89+
- title: FAQ for Docker deployment
90+
url: /faq

‎_sass/_bootstrap_variables.scss

+1
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,5 @@ $h3-font-size: 1rem * 1.5 !default;
3030
$h4-font-size: 1rem * 1.1 !default;
3131
$h5-font-size: 1rem !default;
3232
$h6-font-size: 1rem !default;
33+
$table-bg: $white;
3334

‎images/datahub-to-ena.svg

+337
Loading

‎images/ena-submission-toolbox.svg

+352
Loading

‎pages/ena-submission.md

+130
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
---
2+
title: ENA data submission toolbox
3+
contributors: [Bert Droesbeke, Flora D'Anna]
4+
description: High scale publishing of data to ENA using easy to use metadata templates.
5+
training:
6+
- name: Submission of SARS-CoV-2 sequence data to ENA using Galaxy
7+
registry: YouTube
8+
url: https://www.youtube.com/watch?v=POiQG-7O7rw
9+
- name: "Galaxy Training network: Submitting sequence data to ENA"
10+
registry:
11+
url: https://training.galaxyproject.org/training-material/topics/galaxy-interface/tutorials/upload-data-to-ena/tutorial.html
12+
---
13+
14+
15+
## Introduction
16+
17+
The [European Nucleotide Archive (ENA)](https://www.ebi.ac.uk/ena/browser/) is a fully open repository dedicated to storing raw sequencing data, assemblies, and annotation data. The ENA data submission toolbox simplifies the submission of sequence data, including raw reads and assembled sequences by offering a single-step submission process, a graphical user interface, tabular-formatted metadata and client-side validation, for every sample checklist supported at ENA.
18+
19+
20+
## Its components
21+
22+
{% include image.html file="ena-submission-toolbox.svg" caption="<b>Figure 1.</b> Overview of the ENA submission toolbox components." %}
23+
24+
25+
### ENA upload CLI
26+
27+
Command line tool allowing submission of raw reads data and respective metadata to ENA using tabular files or an excel sheet. Programmatically submit study, sample, run and experiment objects without the need of logging in to the [ENA Webin interface](https://www.ebi.ac.uk/ena/submit/webin/login).
28+
29+
Key features:
30+
- Submit raw sequencing data and metadata
31+
- High volume submissions
32+
- Support for all sample types
33+
- Use tabular files or an excel sheet to easily capture the metadata
34+
- Add, modify, cancel and release ENA objects (study, experiment, run and sample) taking away the need login into ENA Webin.
35+
- Safe credential management using a credentials file
36+
- Client side validation using ENA checklists (samples) and official ENA XSD files (run, experiment and study)
37+
- Compatible with the provided tsv/xlsx templates to fill in the metadata ([see below](#metadata-templates))
38+
39+
[<i class="fa-brands fa-github me-2"></i>Documentation + source](https://github.com/usegalaxy-eu/ena-upload-cli){: class="btn btn-light border rounded-pill"}
40+
[<i class="fa-solid fa-download me-2"></i>Install using pip](https://pypi.org/project/ena-upload-cli/){: class="btn btn-light border rounded-pill"}
41+
42+
### Galaxy
43+
44+
[Galaxy](https://galaxyproject.org/eu/) is an open-source platform for FAIR data analysis that enables users to use tools from various domains through its graphical web interface. The 2 tool wrappers listed below make Galaxy your one stop shop for data preprocessing, analysing and submitting. Both tools can be installed through the Galaxy toolshed.
45+
46+
#### Galaxy ENA upload tool
47+
48+
This is the Galaxy tool wrapper of the ENA-upload-cli mentioned above. The integration with Galaxy gives the command line tool a graphic user interface and adds support for interactive submissions.
49+
50+
Key features:
51+
- Graphical user interface making it easy to use
52+
- Raw read submissions
53+
- ENA-upload-cli at its core
54+
- Add and modify ENA objects
55+
- User based credential management
56+
- Possibility to set a system-wide brokering account
57+
- Easy data upload/management
58+
- Available at [useGalaxy Europe](https://usegalaxy.eu/), [useGalaxy Belgium](https://usegalaxy.be/) and [useGalaxy Australia](https://usegalaxy.org.au/)
59+
60+
[<i class="fa-solid fa-play me-2"></i>Use at useGalaxy.be](https://usegalaxy.be/?tool_id=toolshed.g2.bx.psu.edu%2Frepos%2Fiuc%2Fena_upload%2Fena_upload){: class="btn btn-light border rounded-pill"}
61+
[<i class="fa-brands fa-github me-2"></i>Source](https://github.com/galaxyproject/tools-iuc/tree/master/tools/ena_upload){: class="btn btn-light border rounded-pill"}
62+
[<i class="fa-solid fa-graduation-cap me-2"></i>Tutorial on GTN](https://training.galaxyproject.org/training-material/topics/galaxy-interface/tutorials/upload-data-to-ena/tutorial.html#submitting-raw-sequence-data-reads-to-the-ena){: class="btn btn-light border rounded-pill"}
63+
[<i class="fa-solid fa-download me-2"></i>Galaxy toolshed](https://toolshed.g2.bx.psu.edu/repository?repository_id=0db04aa13ef9d2f8){: class="btn btn-light border rounded-pill"}
64+
65+
66+
#### Galaxy assembly submission tool
67+
68+
Galaxy wrapper to submit consensus sequences to ENA in an interactive way. The tool has the [Webin-CLI](https://github.com/enasequence/webin-cli) script of ENA at its core and supports all sample checklists.
69+
70+
Key features:
71+
- Interactive submission of the metadata
72+
- Possibility to set a brokering account
73+
- Easy data upload/management
74+
- Available at [useGalaxy Belgium](https://usegalaxy.be/)
75+
76+
[<i class="fa-solid fa-play me-2"></i>Use at useGalaxy.be](https://usegalaxy.be/?tool_id=toolshed.g2.bx.psu.edu%2Frepos%2Fieguinoa%2Fena_webin_cli%2Fena_consensus_submit){: class="btn btn-light border rounded-pill"}
77+
[<i class="fa-brands fa-github me-2"></i>Source](https://github.com/usegalaxy-be/galaxytools/tree/main/consensus_sequence_ena_galaxy){: class="btn btn-light border rounded-pill"}
78+
[<i class="fa-solid fa-graduation-cap me-2"></i>Tutorial on GTN](https://training.galaxyproject.org/training-material/topics/galaxy-interface/tutorials/upload-data-to-ena/tutorial.html#submitting-consensus-sequences-to-ena){: class="btn btn-light border rounded-pill"}
79+
[<i class="fa-solid fa-download me-2"></i>Galaxy toolshed](https://toolshed.g2.bx.psu.edu/repository?repository_id=dfa4f0fc31027b52){: class="btn btn-light border rounded-pill"}
80+
81+
82+
### Metadata templates
83+
84+
Tabular-format and xlsx spreadsheet metadata templates required to submit data to ENA using the ENA-upload-cli or GALAXY ENA upload tool. A GitHub Action is put in place to automatically keep these templates up to date with the ENA sample checklists.
85+
86+
Key features:
87+
- GitHub repo hosting tsv and xlsx templates for every checklist
88+
- GitHub Actions to keep up to date with ENA XSD/checklist files to guarantee compatibility
89+
- Versions in sync with the ones from ENA-upload-CLI
90+
91+
[<i class="fa-brands fa-github me-2"></i>Documentation + source](https://github.com/ELIXIR-Belgium/ENA-metadata-templates){: class="btn btn-light border rounded-pill"}
92+
93+
### Docker deployment
94+
95+
When you can not use the Galaxy instances at useGalaxy.eu, .be and .au, possibly due to GDPR reasons, we also offer a ready to use Docker container. The Docker container is shipped with the previously mentioned Galaxy tools and deploys locally a fully usable Galaxy instance.
96+
97+
Key features:
98+
- Easy deployment of a local Galaxy instance
99+
- Data stays on-premise until submission
100+
- Contains:
101+
- ENA-upload tool
102+
- ENA Assembly submission tool
103+
- Tool to easily clean raw reads from human reads
104+
105+
[<i class="fa-brands fa-github me-2"></i>Documentation + source](https://github.com/ELIXIR-Belgium/ena-upload-container){: class="btn btn-light border rounded-pill"}
106+
[<i class="fa-solid fa-download me-2"></i>Download image from Quay.io](https://quay.io/repository/galaxy/ena-upload){: class="btn btn-light border rounded-pill"}
107+
108+
109+
## Using DataHub to manage your metadata
110+
111+
{% include image.html file="datahub-to-ena.svg" caption="<b>Figure 2.</b> Submission flow of metadata from DataHub to ENA" %}
112+
113+
[DataHub](https://datahub-test.elixir-belgium.org/) is a free and open platform for easier Research metaData Management in Life Sciences. Based on [FAIRDOM-SEEK](https://seek4science.org/), DataHub offers users the ability to effortlessly create sample metadata templates derived from ENA-specific templates for seamless compatibility with the ENA repository.
114+
115+
Key features:
116+
- Powered by FAIRDOM-SEEK open-source software, DataHub facilitates effective research metadata management
117+
- Easily craft metadata templates tailored to various repositories
118+
- Promoting and supporting ENA standards and checklists ensures data consistency and compliance
119+
- Streamline data exchange with structured metadata export adhering to the ISA-JSON standard
120+
- Promote ISA-JSON as a machine-actionable metadata carrier, enhancing interoperability
121+
122+
{% include callout.html type="note" content="Please note that specific documentation on creating ISA-JSON for ENA in DataHub is a work in progress and will be available soon." %}
123+
124+
[<i class="fa-solid fa-play me-2"></i>Try out on DataHub](https://datahub-test.elixir-belgium.org/){: class="btn btn-light border rounded-pill"}
125+
126+
127+
## Publication
128+
129+
Roncoroni, M., Droesbeke, B., Eguinoa, I., De Ruyck, K., D’Anna, F., Yusuf, D., Grüning, B., Backofen, R., & Coppens, F. (2021). A SARS-CoV-2 sequence submission tool for the European Nucleotide Archive. Bioinformatics, 37(21), 3983–3985. [https://doi.org/10.1093/bioinformatics/btab421](https://doi.org/10.1093/bioinformatics/btab421)
130+

‎pages/covid-19/faq.md ‎pages/faq.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
2-
permalink: covid-19/faq
3-
title: Frequently asked questions
2+
title: FAQ for Docker deployment
43
---
54

65
### Why is the reads cleaning tool not showing files for input?

0 commit comments

Comments
 (0)