Skip to content

Commit 69ddfa2

Browse files
committed
documentation update
1 parent eb4b96d commit 69ddfa2

2 files changed

Lines changed: 18 additions & 7 deletions

File tree

README.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
# ENA upload tool
99

10-
This command line tool (CLI) allows easy submission of experimental data and respective metadata to the European Nucleotide Archive (ENA) using tabular files. The supported metadata that can be submitted includes study, sample, run and experiment info so you can use the tool for programatic submission of everything ENA needs without the need of logging in to the Webin interface. This also includes client side validation using ENA checklists and releasing the ENA objects. This command line tool is also available as a [Galaxy tool](https://toolshed.g2.bx.psu.edu/view/iuc/ena_upload/4aab5ae907b6) and can be added to you own Galaxy instance or you can make use of one of the existing Galaxy instances, like [usegalaxy.eu](https://usegalaxy.eu/root?tool_id=toolshed.g2.bx.psu.edu/repos/iuc/ena_upload/ena_upload).
10+
This command line tool (CLI) allows easy submission of experimental data and respective metadata to the European Nucleotide Archive (ENA) using tabular files of one of the excel spreadsheet that can be found on this [template repo](https://github.com/ELIXIR-Belgium/ENA-metadata-templates). The supported metadata that can be submitted includes study, sample, run and experiment info so you can use the tool for programatic submission of everything ENA needs without the need of logging in to the Webin interface. This also includes client side validation using ENA checklists and releasing the ENA objects. This command line tool is also available as a [Galaxy tool](https://toolshed.g2.bx.psu.edu/view/iuc/ena_upload/4aab5ae907b6) and can be added to you own Galaxy instance or you can make use of one of the existing Galaxy instances, like [usegalaxy.eu](https://usegalaxy.eu/root?tool_id=toolshed.g2.bx.psu.edu/repos/iuc/ena_upload/ena_upload).
1111

1212
## Overview
1313

@@ -60,15 +60,16 @@ All supported arguments:
6060
--experiment EXPERIMENT
6161
table of EXPERIMENT object
6262
--run RUN table of RUN object
63-
--data [FILE [FILE ...]]
64-
data for submission
63+
--data [FILE ...] data for submission
6564
--center CENTER_NAME specific to your Webin account
6665
--checklist CHECKLIST
6766
specify the sample checklist with following pattern: ERC0000XX, Default: ERC000011
67+
--xlsx XLSX Excel table with metadata
6868
--tool TOOL_NAME specify the name of the tool this submission is done with. Default: ena-upload-cli
6969
--tool_version TOOL_VERSION
7070
specify the version of the tool this submission is done with
71-
--no_data_upload indicate if no upload should be performed and you like to submit a RUN object (e.g. if uploaded was done separately).
71+
--no_data_upload indicate if no upload should be performed and you like to submit a RUN object (e.g. if uploaded
72+
was done separately).
7273
--draft indicate if no submission should be performed
7374
--secret SECRET .secret.yml file containing the password and Webin ID of your ENA account
7475
-d, --dev flag to use the dev/sandbox endpoint of ENA
@@ -172,6 +173,11 @@ Optionally you can add a status column to every table that contains the action y
172173

173174
> IMPORTANT: if the status column is given but not filled in, or filled in with a different action from the one in the `--action` parameter, not rows will be submitted! Either leave out the column or add to every row the corect action.
174175
176+
177+
### Using Excel templates
178+
179+
We also support the use of specific excel templates, designed for each sample checklist. Use the `--xlsx` command to add the path to an excel template file filled in from this [template repo](https://github.com/ELIXIR-Belgium/ENA-metadata-templates).
180+
175181
### The data files
176182

177183
**Supported data**
@@ -206,8 +212,8 @@ By default the updated tables after submission will have the action `added` in t
206212
## Tool overview
207213

208214
**inputs**:
209-
* metadata tables
210-
* examples in `example_table`
215+
* metadata tables/excelsheet
216+
* examples in `example_table` and on this [template repo](https://github.com/ELIXIR-Belgium/ENA-metadata-templates) for excel sheets
211217
* (optional) define actions in **status** column e.g. `add`, `modify`, `cancel`, `release` (when not given the whole table is submitted)
212218
* to perform bulk submission of all objects, the `aliases ids` in different ENA objects should be in the association where alias ids in experiment object link all objects together
213219
* experimental data
@@ -248,6 +254,11 @@ By default the updated tables after submission will have the action `added` in t
248254
ena-upload-cli --action add --center 'your_center_name' --study example_tables/ENA_template_studies.tsv --sample example_tables/ENA_template_samples_vir.tsv --experiment example_tables/ENA_template_experiments.tsv --run example_tables/ENA_template_runs.tsv --data example_data/*gz --dev --checklist ERC000033 --secret .secret.yml
249255
```
250256

257+
* **Using an Excel template**
258+
```
259+
ena-upload-cli --action add --center 'your_center_name' --data example_data/*gz --dev --checklist ERC000033 --secret .secret.yml --xlsx example_tables/ENA_excel_example_ERC000033.xlsx
260+
```
261+
251262
* **release submission**
252263
```
253264
ena-upload-cli --action release --center'your_center_name' --study example_tables/ENA_template_studies_release.tsv --dev --secret .secret.yml

ena_upload/ena_upload.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -686,7 +686,7 @@ def process_args():
686686
default='ERC000011')
687687

688688
parser.add_argument('--xlsx',
689-
help='Excel table with metadata')
689+
help='excel table with metadata')
690690

691691
parser.add_argument('--tool',
692692
dest='tool_name',

0 commit comments

Comments
 (0)