4
|
1 <tool id="MaREA" name="Metabolic Enrichment Analysis" version="1.0.0">
|
0
|
2 <description>for Galaxy</description>
|
1
|
3 <macros>
|
|
4 <import>marea_macros.xml</import>
|
|
5 </macros>
|
0
|
6 <requirements>
|
5
|
7 <requirement type="package" version="0.23.0">pandas</requirement>
|
|
8 <requirement type="package" version="1.1.0">scipy</requirement>
|
6
|
9 <requirement type="package" version="0.10.1">cobra</requirement>
|
5
|
10 <requirement type="package" version="4.2.1">lxml</requirement>
|
|
11 <requirement type="package" version="0.8.1">svglib</requirement>
|
|
12 <requirement type="package" version="3.4.0">reportlab</requirement>
|
0
|
13 </requirements>
|
1
|
14 <command detect_errors="exit_code">
|
0
|
15 <![CDATA[
|
|
16 python $__tool_directory__/marea.py
|
|
17 --rules_selector $cond_rule.rules_selector
|
|
18 #if $cond_rule.rules_selector == 'Custom':
|
|
19 --custom ${cond_rule.Custom_rules}
|
|
20 --yes_no ${cond_rule.cond_map.yes_no}
|
|
21 #if $cond_rule.cond_map.yes_no == 'yes':
|
|
22 --custom_map $cond_rule.cond_map.Custom_map
|
|
23 #end if
|
|
24 #end if
|
|
25 --none $None
|
|
26 --pValue $pValue
|
|
27 --fChange $fChange
|
|
28 --tool_dir $__tool_directory__
|
|
29 --option $cond.type_selector
|
|
30 --out_log $log
|
|
31 #if $cond.type_selector == 'datasets':
|
|
32 --input_datas
|
|
33 #for $data in $cond.input_Datasets:
|
|
34 ${data.input}
|
|
35 #end for
|
|
36 --names
|
|
37 #for $data in $cond.input_Datasets:
|
|
38 ${data.input_name}
|
|
39 #end for
|
|
40 #elif $cond.type_selector == 'dataset_class':
|
|
41 --input_data ${input_data}
|
|
42 --input_class ${input_class}
|
|
43 #end if
|
|
44 ]]>
|
|
45 </command>
|
1
|
46
|
0
|
47 <inputs>
|
|
48 <conditional name="cond_rule">
|
2
|
49 <expand macro="options"/>
|
1
|
50 <when value="HMRcore">
|
|
51 </when>
|
|
52 <when value="Recon">
|
|
53 </when>
|
0
|
54 <when value="Custom">
|
1
|
55 <param name="Custom_rules" type="data" format="tabular, csv, tsv, xml" label="Custom rules" />
|
0
|
56 <conditional name="cond_map">
|
|
57 <param name="yes_no" type="select" label="Custom map? (optional)">
|
|
58 <option value="no" selected="true">no</option>
|
|
59 <option value="yes">yes</option>
|
|
60 </param>
|
|
61 <when value="yes">
|
1
|
62 <param name="Custom_map" argument="--custom_map" type="data" format="xml, svg" label="custom-map.svg"/>
|
|
63 </when>
|
|
64 <when value="no">
|
0
|
65 </when>
|
|
66 </conditional>
|
|
67 </when>
|
|
68 </conditional>
|
|
69 <conditional name="cond">
|
1
|
70 <param name="type_selector" argument="--option" type="select" label="Input format:">
|
|
71 <option value="datasets" selected="true">RNAseq of group 1 + RNAseq of group 2 + ... + RNAseq of group N</option>
|
0
|
72 <option value="dataset_class">RNAseq of all samples + sample group specification</option>
|
|
73 </param>
|
|
74 <when value="datasets">
|
4
|
75 <repeat name="input_Datasets" title="RNAseq" min="2">
|
1
|
76 <param name="input" argument="--input_datas" type="data" format="tabular, csv, tsv" label="add dataset" />
|
|
77 <param name="input_name" argument="--names" type="text" label="Dataset's name:" value="Dataset" help="Defalut: Dataset" />
|
4
|
78 </repeat>
|
0
|
79 </when>
|
|
80 <when value="dataset_class">
|
1
|
81 <param name="input_data" argument="--input_data" type="data" format="tabular, csv, tsv" label="RNAseq of all samples" />
|
|
82 <param name="input_class" argument="--input_class" type="data" format="tabular, csv, tsv" label="Sample group specification" />
|
0
|
83 </when>
|
|
84 </conditional>
|
1
|
85 <param name="None" argument="--none" type="boolean" truevalue="true" falsevalue="false" checked="true" label="(A and NaN) solved as (A)?" />
|
13
|
86 <param name="pValue" argument="--pValue" type="float" size="20" value="0.05" max="1" min="0" label="P-value threshold:" help="min value 0" />
|
|
87 <param name="fChange" argument="--fChange" type="float" size="20" value="1.5" min="1" label="Fold-Change threshold:" help="min value 1" />
|
0
|
88 </inputs>
|
1
|
89
|
0
|
90 <outputs>
|
1
|
91 <data format="txt" name="log" label="Log" />
|
|
92 <collection name="map_svg" type="list" label="Graphical results (.svg)">
|
0
|
93 <filter>(cond_rule['rules_selector'] == 'HMRcore') or ((cond_rule['rules_selector'] == 'Custom') and (cond_rule['cond_map']['yes_no'] == 'yes'))</filter>
|
1
|
94 <discover_datasets pattern="__name_and_ext__" directory="map_svg" />
|
0
|
95 </collection>
|
1
|
96 <collection name="map_pdf" type="list" label="Graphical results (.pdf)">
|
0
|
97 <filter>(cond_rule['rules_selector'] == 'HMRcore') or ((cond_rule['rules_selector'] == 'Custom') and (cond_rule['cond_map']['yes_no'] == 'yes'))</filter>
|
1
|
98 <discover_datasets pattern="__name_and_ext__" directory="map_pdf" />
|
0
|
99 </collection>
|
1
|
100 <collection name="table_out" type="list" label="Tabular results">
|
|
101 <discover_datasets pattern="__name_and_ext__" directory="table_out" />
|
0
|
102 </collection>
|
|
103 </outputs>
|
4
|
104 <tests>
|
|
105 <test>
|
|
106 <param name="pValue" value="0.56"/>
|
|
107 <output name="log" file="log.txt"/>
|
|
108 </test>
|
|
109 </tests>
|
0
|
110 <help>
|
|
111 <![CDATA[
|
|
112
|
|
113 What it does
|
|
114 -------------
|
|
115
|
|
116 This tool analyzes RNA-seq dataset(s) as described in Graudenzi et al."`MaREA`_: Metabolic feature extraction, enrichment and visualization of RNAseq data" bioRxiv (2018): 248724.
|
|
117
|
1
|
118 Accepted files are:
|
|
119 - option 1) two or more RNA-seq datasets, each referring to samples in a given condition/class. The user can specify a label for each class (as e.g. "*classA*" and "*classB*");
|
|
120 - option 2) one RNA dataset and one class-file specifying the class/condition each sample belongs to.
|
|
121
|
|
122 Optional files:
|
|
123 - custom GPR (Gene-Protein-Reaction) rules. Two accepted formats:
|
0
|
124
|
1
|
125 * (Cobra Toolbox and CobraPy compliant) xml of metabolic model;
|
|
126 * .csv file specifyig for each reaction ID (column 1) the corresponding GPR rule (column 2).
|
|
127 - custom svg map. Graphical elements must have the same IDs of reactions. See HmrCore svg map for an example.
|
0
|
128
|
1
|
129 The tool generates:
|
|
130 1) a tab-separated file: reporting fold-change and p-values of reaction activity scores (RASs) between a pair of conditions/classes;
|
|
131 2) a metabolic map file (downlodable as .svg): visualizing up- and down-regulated reactions between a pair of conditions/classes;
|
|
132 3) a log file (.txt).
|
0
|
133
|
1
|
134 RNA-seq datasets format: tab-separated text files, reporting the expression level (e.g., TPM, RPKM, ...) of each gene (row) for a given sample (column). Header: sample ID.
|
0
|
135
|
|
136 Class-file format: each row of the class-file reports the sample ID (column1) and the label of the class/condition the sample belongs to (column 2).
|
|
137
|
|
138 To calculate P-Values and Fold-Changes and to generate maps, comparisons are performed for each possible pair of classes.
|
|
139
|
1
|
140 Output files will be named as classA_vs_classB. Reactions will conventionally be reported as up-regulated (down-regulated) if they are significantly more (less) active in class having label "classA".
|
0
|
141
|
|
142
|
|
143 Example input
|
|
144 -------------
|
|
145
|
1
|
146 **"Custom Rules"** option:
|
|
147
|
|
148 Custom Rules Dastaset:
|
0
|
149
|
1
|
150 @CUSTOM_RULES_EXEMPLE@
|
|
151
|
|
152 **"RNAseq of group 1 + RNAseq of group 2 + ... + RNAseq of group N"** option:
|
0
|
153
|
1
|
154 RNA-seq Dataset 1:
|
|
155
|
|
156 @DATASET_EXEMPLE1@
|
0
|
157
|
1
|
158 RNA-seq Dataset 2:
|
0
|
159
|
1
|
160 @DATASET_EXEMPLE2@
|
0
|
161
|
|
162 **"RNAseq of all samples + sample group specification"** option:
|
|
163
|
1
|
164 RNA-seq Dataset:
|
0
|
165
|
1
|
166 @DATASET_EXEMPLE1@
|
0
|
167
|
|
168 Class-file:
|
|
169
|
|
170 +------------+------------+
|
|
171 | Patient_ID | class |
|
|
172 +============+============+
|
|
173 | TCGAAA3529 | MSI |
|
|
174 +------------+------------+
|
|
175 | TCGAA62671 | MSS |
|
|
176 +------------+------------+
|
|
177 | TCGAA62672 | MSI |
|
|
178 +------------+------------+
|
|
179
|
|
180 |
|
|
181
|
|
182 .. class:: infomark
|
|
183
|
1
|
184 **TIP**: If your data is not TAB delimited, use `Convert delimiters to TAB`_.
|
0
|
185
|
|
186 .. class:: infomark
|
|
187
|
1
|
188 **TIP**: If your dataset is not split into classes, use `MaREA cluster analysis`_.
|
0
|
189
|
1
|
190 @REFERENCE@
|
0
|
191
|
1
|
192 .. _MaREA: https://www.biorxiv.org/content/early/2018/01/16/248724
|
0
|
193 .. _Convert delimiters to TAB: https://usegalaxy.org/?tool_id=Convert+characters1&version=1.0.0&__identifer=6t22teyofhj
|
1
|
194 .. _MaREA cluster analysis: http://link del tool di cluster.org
|
0
|
195
|
|
196 ]]>
|
|
197 </help>
|
1
|
198 <expand macro="citations" />
|
0
|
199 </tool>
|
|
200
|