Mercurial > repos > prog > mtblsdwnld
annotate mtbls-dwnld.xml @ 1:1fd8547867be draft default tip
"planemo upload commit 76293bd47447c171c939b4f3c194fd0cfbd7f69c-dirty"
author | prog |
---|---|
date | Thu, 04 Mar 2021 11:21:03 +0000 |
parents | 8dab200e02cb |
children |
rev | line source |
---|---|
0
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
1 <!-- vi: se fdm=marker : --> |
1
1fd8547867be
"planemo upload commit 76293bd47447c171c939b4f3c194fd0cfbd7f69c-dirty"
prog
parents:
0
diff
changeset
|
2 <tool id="mtbls-dwnld" name="Metabolights downloader" version="4.1.5"> |
0
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
3 |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
4 <description>Import public and private MetaboLights studies</description> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
5 |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
6 <requirements> |
1
1fd8547867be
"planemo upload commit 76293bd47447c171c939b4f3c194fd0cfbd7f69c-dirty"
prog
parents:
0
diff
changeset
|
7 <requirement type="package" version="0.12.0">isatools</requirement> |
0
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
8 </requirements> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
9 |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
10 <!-- Command {{{1 --> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
11 |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
12 <command><![CDATA[ |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
13 ## @@@BEGIN_CHEETAH@@@ |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
14 |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
15 $__tool_directory__/mtbls-dwnld |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
16 |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
17 -q -T |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
18 #if $token: |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
19 -t "$token" |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
20 #end if |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
21 #if $type == 'private': |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
22 -p |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
23 #end if |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
24 #if $downloader == 'aspera': |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
25 -a |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
26 #end if |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
27 |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
28 ## Download only the metadata |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
29 #if $only_metadata == 'yes': |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
30 -M |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
31 #end if |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
32 |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
33 ## Set output file |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
34 -H "$isastudy" |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
35 -o "$isastudy.files_path" |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
36 |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
37 ## Factor slicing |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
38 #if $factor_slicing.factor_name: |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
39 -f "$factor_slicing.factor_name=$factor_slicing.factor_value" |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
40 #end if |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
41 |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
42 ## Study to output |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
43 "$study" |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
44 |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
45 ## @@@END_CHEETAH@@@ |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
46 ]]></command> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
47 |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
48 <!-- Inputs {{{1 --> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
49 |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
50 <inputs> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
51 |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
52 <!-- Study name --> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
53 <param name="study" type="text" label="Study name" help="Study name in the form MTBLSXXXX. For downloading a private study with Aspera client, set to the full path of the study. See details below." refresh_on_change="true"/> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
54 |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
55 <!-- Public or private --> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
56 <param name="type" label="Study type" type="select" help="Indicate here if the study you want to download is public or private."> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
57 <option value="public">Public</option> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
58 <option value="private">Private</option> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
59 </param> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
60 |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
61 <!-- Downloader --> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
62 <param name="downloader" label="Downloader" type="select" help="If downloading only the metadata prefer wget, otherwise you can choose aspera."> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
63 <option value="wget">wget</option> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
64 <option value="aspera">Aspera</option> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
65 </param> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
66 |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
67 <!-- Token --> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
68 <param name="token" type="text" optional="true" format="txt" label="Token" help="A token is required for private studies. A default token is provided for downloading public studies with aspera, but you can set your own if you wish."/> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
69 |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
70 <!-- Metadata --> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
71 <param name="only_metadata" label="Content to download" type="select" display="radio" help="Specify here what files you want to download from the study."> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
72 <option value="yes">ISA-Tab metadata only.</option> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
73 <option value="no">Full study including raw data and ISA-Tab metadata.</option> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
74 </param> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
75 |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
76 <!-- Factor slicing --> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
77 <section name="factor_slicing" title="Slicing by factor value" expanded="true" help="With this option, you can restrict the set of files you download from the study."> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
78 <param name="factor_name" type="text" size="128" label="Factor title"/> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
79 <param name="factor_value" type="text" size="128" label="Factor value"/> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
80 </section> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
81 </inputs> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
82 |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
83 <!-- Outputs {{{1 --> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
84 |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
85 <outputs> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
86 <data name="isastudy" label="${study}" format="isa-tab"/> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
87 </outputs> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
88 |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
89 <!-- Tests {{{1 --> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
90 <tests> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
91 <!-- Simple retrieving with wget --> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
92 <test> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
93 <param name="study" value="MTBLS2"/> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
94 <param name="type" value="public"/> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
95 <param name="downloader" value="wget"/> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
96 <param name="metadata" value="yes"/> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
97 <param name="token" value=""/> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
98 <output name="isastudy" file="MTBLS2.html"/> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
99 </test> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
100 |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
101 <!-- Slicing --> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
102 <test> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
103 <param name="study" value="MTBLS2"/> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
104 <param name="type" value="public"/> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
105 <param name="downloader" value="wget"/> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
106 <param name="metadata" value="yes"/> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
107 <param name="token" value=""/> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
108 <param name="factor_name" value="Factor Value[genotype]"/> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
109 <param name="factor_value" value="cyp79"/> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
110 <output name="isastudy" file="MTBLS2.html"/> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
111 </test> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
112 </tests> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
113 |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
114 <!-- Help {{{1 --> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
115 <help> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
116 <!-- @@@BEGIN_RST@@@ --> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
117 |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
118 ======================= |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
119 Metabolights Downloader |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
120 ======================= |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
121 |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
122 A tool to download data from MetaboLights studies. You can download either a private or a public study, using `wget` as well as `aspera` methods. |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
123 The output is an ISA dataset. |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
124 |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
125 ------------- |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
126 Input setting |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
127 ------------- |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
128 |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
129 Study name |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
130 ========== |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
131 |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
132 Fill this field with the name of the study you want to download. |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
133 |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
134 .. class:: warningmark |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
135 |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
136 In case of the download of a private study with *aspera* downloader, you must write the full path of the study, not only the name. |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
137 It is a requirement that you have requested an "FTP folder" for the private study from the metabolights-curation@ebi.ac.uk team. |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
138 |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
139 Study type |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
140 ========== |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
141 |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
142 You must select here the type of the study, which can be either *public* or *private*. In case of a *private* study, you will have to input a security token. |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
143 |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
144 Downloader |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
145 ========== |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
146 |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
147 With this field, you can control the program used for downloading the study. You have the choice between standard *wget* and *aspera*. *wget* will download the data through *http*, while *aspera* will do it through *ftp*. If you are only interested in the metadata, choose *wget* since it is able to download only these data. If you are interested in *mzML* or *mzData* files, choose *aspera* as it is a faster downloader. |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
148 |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
149 Metadata |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
150 ======== |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
151 |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
152 If you are only interested in metadata, choose *Yes*, and make sure to select *wget* as well in the **Downloader** field. |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
153 If you set this field to *No*, then the tool will try to extract *mzData* and *mzML* files and output them as collections. |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
154 |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
155 Token |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
156 ===== |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
157 |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
158 You need to provide a token when downloading with *aspera* (both for private and public studies), or when downloading a private study with *wget*. |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
159 |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
160 ------ |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
161 Output |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
162 ------ |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
163 |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
164 The output is an ISA-Tab dataset that can be used in subsequent tools like isa2w4m. |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
165 The ISA-Tab dataset stores all files contain in the downloaded Metabolights study. |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
166 |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
167 --------------------- |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
168 Developer information |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
169 --------------------- |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
170 |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
171 The Metabolights downloader downloads a compressed archive from Metabolights database and extract it inside Galaxy dataset folder. It creates an HTML file (used as primary file) and extract all files from archive inside the subfolder ``<name_of_the_HTML_file>_files``. |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
172 |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
173 Note that neither the uploader nor the ISA Galaxy data type are involved during this process. This is the reason why the downloader has to create itself an HTML file that will serve as primary file and to extract files inside ``*_files`` subfolder. |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
174 |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
175 A subsequent tool that would use the output of the Metabolights downloader has to declare the input as ISA type:: |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
176 |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
177 <param name="isa" label="ISA" type="data" format="isa"/> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
178 |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
179 Then to use it inside the command tag, one must use the variable ``$isa.extra_files_path`` to get the path of the folder where all ISA archive files have been extracted:: |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
180 |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
181 <command><![CDATA[some-program-to-run --the-isa-folder "$isa.extra_files_path" ]]></command> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
182 |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
183 The easiest way to use the ISA archive inside the run program is then to use the Python3 library isatools to load it. See https://github.com/ISA-tools/isa-api for information. |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
184 |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
185 ---------------------- |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
186 Network considerations |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
187 ---------------------- |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
188 |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
189 The networking of the Galaxy instance needs to allow UDP connections with source port 33001 for the fast Aspera download. This is the case for most commercial providers, including Amazon AWS and Google GCP, but some local installations might have additional firewall rules in place. See also https://test-connect.asperasoft.com/ for more information. If these connections are not allowed, the fallback to the wget download via is still possible. |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
190 |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
191 <!-- @@@END_RST@@@ --> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
192 </help> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
193 |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
194 <!-- Citations {{{1 --> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
195 <citations> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
196 <citation type="doi">10.1002/0471250953.bi1413s53</citation> <!-- Metabolights --> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
197 <citation type="doi">10.1007/s11306-015-0879-3</citation> <!-- Metabolights --> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
198 <citation type="doi">10.1038/ng.1054</citation> <!-- ISA --> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
199 </citations> |
8dab200e02cb
"planemo upload commit 239561a6401593c5f87df40ac971a9aa393c4663-dirty"
prog
parents:
diff
changeset
|
200 </tool> |