|
7 | 7 |
|
8 | 8 | # ENA upload tool |
9 | 9 |
|
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). |
11 | 11 |
|
12 | 12 | ## Overview |
13 | 13 |
|
@@ -60,15 +60,16 @@ All supported arguments: |
60 | 60 | --experiment EXPERIMENT |
61 | 61 | table of EXPERIMENT object |
62 | 62 | --run RUN table of RUN object |
63 | | - --data [FILE [FILE ...]] |
64 | | - data for submission |
| 63 | + --data [FILE ...] data for submission |
65 | 64 | --center CENTER_NAME specific to your Webin account |
66 | 65 | --checklist CHECKLIST |
67 | 66 | specify the sample checklist with following pattern: ERC0000XX, Default: ERC000011 |
| 67 | + --xlsx XLSX Excel table with metadata |
68 | 68 | --tool TOOL_NAME specify the name of the tool this submission is done with. Default: ena-upload-cli |
69 | 69 | --tool_version TOOL_VERSION |
70 | 70 | 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). |
72 | 73 | --draft indicate if no submission should be performed |
73 | 74 | --secret SECRET .secret.yml file containing the password and Webin ID of your ENA account |
74 | 75 | -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 |
172 | 173 |
|
173 | 174 | > 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. |
174 | 175 |
|
| 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 | + |
175 | 181 | ### The data files |
176 | 182 |
|
177 | 183 | **Supported data** |
@@ -206,8 +212,8 @@ By default the updated tables after submission will have the action `added` in t |
206 | 212 | ## Tool overview |
207 | 213 |
|
208 | 214 | **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 |
211 | 217 | * (optional) define actions in **status** column e.g. `add`, `modify`, `cancel`, `release` (when not given the whole table is submitted) |
212 | 218 | * 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 |
213 | 219 | * experimental data |
@@ -248,6 +254,11 @@ By default the updated tables after submission will have the action `added` in t |
248 | 254 | 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 |
249 | 255 | ``` |
250 | 256 |
|
| 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 | + |
251 | 262 | * **release submission** |
252 | 263 | ``` |
253 | 264 | ena-upload-cli --action release --center'your_center_name' --study example_tables/ENA_template_studies_release.tsv --dev --secret .secret.yml |
|
0 commit comments