annotate README.md @ 0:d9aa2a6dc8f0 draft

"planemo upload commit 7edb56b5ae3e1dd9aa9a66d4bd6d943f42090b87-dirty"
author prog
date Wed, 18 Dec 2019 14:40:46 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
d9aa2a6dc8f0 "planemo upload commit 7edb56b5ae3e1dd9aa9a66d4bd6d943f42090b87-dirty"
prog
parents:
diff changeset
1 Metabolights Downloader
d9aa2a6dc8f0 "planemo upload commit 7edb56b5ae3e1dd9aa9a66d4bd6d943f42090b87-dirty"
prog
parents:
diff changeset
2 =======================
d9aa2a6dc8f0 "planemo upload commit 7edb56b5ae3e1dd9aa9a66d4bd6d943f42090b87-dirty"
prog
parents:
diff changeset
3
d9aa2a6dc8f0 "planemo upload commit 7edb56b5ae3e1dd9aa9a66d4bd6d943f42090b87-dirty"
prog
parents:
diff changeset
4 [![Build Status](https://travis-ci.org/workflow4metabolomics/mtbls-dwnld.svg?branch=master)](https://travis-ci.org/workflow4metabolomics/mtbls-dwnld)
d9aa2a6dc8f0 "planemo upload commit 7edb56b5ae3e1dd9aa9a66d4bd6d943f42090b87-dirty"
prog
parents:
diff changeset
5
d9aa2a6dc8f0 "planemo upload commit 7edb56b5ae3e1dd9aa9a66d4bd6d943f42090b87-dirty"
prog
parents:
diff changeset
6 A [Metabolights](http://www.ebi.ac.uk/metabolights/) study downloader for [Galaxy](https://galaxyproject.org/), part of the [Workflow4Metabolomics](http://workflow4metabolomics.org/) project, and developed during the [PhenoMeNal](http://phenomenal-h2020.eu/home/) project.
d9aa2a6dc8f0 "planemo upload commit 7edb56b5ae3e1dd9aa9a66d4bd6d943f42090b87-dirty"
prog
parents:
diff changeset
7
d9aa2a6dc8f0 "planemo upload commit 7edb56b5ae3e1dd9aa9a66d4bd6d943f42090b87-dirty"
prog
parents:
diff changeset
8 For more information, see the galaxy tool page, help section, available inside `mtbls-dwnld_config.xml`.
d9aa2a6dc8f0 "planemo upload commit 7edb56b5ae3e1dd9aa9a66d4bd6d943f42090b87-dirty"
prog
parents:
diff changeset
9
d9aa2a6dc8f0 "planemo upload commit 7edb56b5ae3e1dd9aa9a66d4bd6d943f42090b87-dirty"
prog
parents:
diff changeset
10 ## Requirements
d9aa2a6dc8f0 "planemo upload commit 7edb56b5ae3e1dd9aa9a66d4bd6d943f42090b87-dirty"
prog
parents:
diff changeset
11
d9aa2a6dc8f0 "planemo upload commit 7edb56b5ae3e1dd9aa9a66d4bd6d943f42090b87-dirty"
prog
parents:
diff changeset
12 * Python 3.8
d9aa2a6dc8f0 "planemo upload commit 7edb56b5ae3e1dd9aa9a66d4bd6d943f42090b87-dirty"
prog
parents:
diff changeset
13 * isatools 0.10.3
d9aa2a6dc8f0 "planemo upload commit 7edb56b5ae3e1dd9aa9a66d4bd6d943f42090b87-dirty"
prog
parents:
diff changeset
14 * `unzip` program.
d9aa2a6dc8f0 "planemo upload commit 7edb56b5ae3e1dd9aa9a66d4bd6d943f42090b87-dirty"
prog
parents:
diff changeset
15 * `wget` program.
d9aa2a6dc8f0 "planemo upload commit 7edb56b5ae3e1dd9aa9a66d4bd6d943f42090b87-dirty"
prog
parents:
diff changeset
16 * `ascp` (Aspera secure copy) program, version 3.7.4 or greater, which you can download [here](http://downloads.asperasoft.com/en/downloads/62).
d9aa2a6dc8f0 "planemo upload commit 7edb56b5ae3e1dd9aa9a66d4bd6d943f42090b87-dirty"
prog
parents:
diff changeset
17
d9aa2a6dc8f0 "planemo upload commit 7edb56b5ae3e1dd9aa9a66d4bd6d943f42090b87-dirty"
prog
parents:
diff changeset
18 ## Updates
d9aa2a6dc8f0 "planemo upload commit 7edb56b5ae3e1dd9aa9a66d4bd6d943f42090b87-dirty"
prog
parents:
diff changeset
19
d9aa2a6dc8f0 "planemo upload commit 7edb56b5ae3e1dd9aa9a66d4bd6d943f42090b87-dirty"
prog
parents:
diff changeset
20 ### 4.1.4
d9aa2a6dc8f0 "planemo upload commit 7edb56b5ae3e1dd9aa9a66d4bd6d943f42090b87-dirty"
prog
parents:
diff changeset
21
d9aa2a6dc8f0 "planemo upload commit 7edb56b5ae3e1dd9aa9a66d4bd6d943f42090b87-dirty"
prog
parents:
diff changeset
22 * Use MTBLS29 instead of MTBLS30, which has been removed from public repository, for testing.
d9aa2a6dc8f0 "planemo upload commit 7edb56b5ae3e1dd9aa9a66d4bd6d943f42090b87-dirty"
prog
parents:
diff changeset
23 * Make planemo tests pass on Travis-CI.
d9aa2a6dc8f0 "planemo upload commit 7edb56b5ae3e1dd9aa9a66d4bd6d943f42090b87-dirty"
prog
parents:
diff changeset
24 * Run several times ascp downloads for tests on Travis-CI, due to connection issues.
d9aa2a6dc8f0 "planemo upload commit 7edb56b5ae3e1dd9aa9a66d4bd6d943f42090b87-dirty"
prog
parents:
diff changeset
25
d9aa2a6dc8f0 "planemo upload commit 7edb56b5ae3e1dd9aa9a66d4bd6d943f42090b87-dirty"
prog
parents:
diff changeset
26 ### 2.0.4
d9aa2a6dc8f0 "planemo upload commit 7edb56b5ae3e1dd9aa9a66d4bd6d943f42090b87-dirty"
prog
parents:
diff changeset
27
d9aa2a6dc8f0 "planemo upload commit 7edb56b5ae3e1dd9aa9a66d4bd6d943f42090b87-dirty"
prog
parents:
diff changeset
28 * Test presence of downloader program.
d9aa2a6dc8f0 "planemo upload commit 7edb56b5ae3e1dd9aa9a66d4bd6d943f42090b87-dirty"
prog
parents:
diff changeset
29 * Correct running of `wget`.
d9aa2a6dc8f0 "planemo upload commit 7edb56b5ae3e1dd9aa9a66d4bd6d943f42090b87-dirty"
prog
parents:
diff changeset
30
d9aa2a6dc8f0 "planemo upload commit 7edb56b5ae3e1dd9aa9a66d4bd6d943f42090b87-dirty"
prog
parents:
diff changeset
31 ### 2.0.3
d9aa2a6dc8f0 "planemo upload commit 7edb56b5ae3e1dd9aa9a66d4bd6d943f42090b87-dirty"
prog
parents:
diff changeset
32
d9aa2a6dc8f0 "planemo upload commit 7edb56b5ae3e1dd9aa9a66d4bd6d943f42090b87-dirty"
prog
parents:
diff changeset
33 * Allow to choose the downloading method (`wget` or `aspera`).
d9aa2a6dc8f0 "planemo upload commit 7edb56b5ae3e1dd9aa9a66d4bd6d943f42090b87-dirty"
prog
parents:
diff changeset
34 * Ask to specify is the study to download is public or private.
d9aa2a6dc8f0 "planemo upload commit 7edb56b5ae3e1dd9aa9a66d4bd6d943f42090b87-dirty"
prog
parents:
diff changeset
35 * Allow to download all assays at once and convert them to W4M format.
d9aa2a6dc8f0 "planemo upload commit 7edb56b5ae3e1dd9aa9a66d4bd6d943f42090b87-dirty"
prog
parents:
diff changeset
36 * Allow to download *mzMl* and *mzData* files as collections.
d9aa2a6dc8f0 "planemo upload commit 7edb56b5ae3e1dd9aa9a66d4bd6d943f42090b87-dirty"
prog
parents:
diff changeset
37
d9aa2a6dc8f0 "planemo upload commit 7edb56b5ae3e1dd9aa9a66d4bd6d943f42090b87-dirty"
prog
parents:
diff changeset
38 ### 1.3.0
d9aa2a6dc8f0 "planemo upload commit 7edb56b5ae3e1dd9aa9a66d4bd6d943f42090b87-dirty"
prog
parents:
diff changeset
39
d9aa2a6dc8f0 "planemo upload commit 7edb56b5ae3e1dd9aa9a66d4bd6d943f42090b87-dirty"
prog
parents:
diff changeset
40 * Allow to choose the assay to extract and convert to W4M format.