|
29
|
1 <tool id="MaREA" name="Metabolic Reaction Enrichment Analysis" version="1.0.2">
|
|
26
|
2 <description></description>
|
|
16
|
3 <macros>
|
|
|
4 <import>marea_macros.xml</import>
|
|
|
5 </macros>
|
|
|
6 <requirements>
|
|
|
7 <requirement type="package" version="0.23.0">pandas</requirement>
|
|
|
8 <requirement type="package" version="1.1.0">scipy</requirement>
|
|
|
9 <requirement type="package" version="0.10.1">cobra</requirement>
|
|
|
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>
|
|
|
13 </requirements>
|
|
|
14 <command detect_errors="exit_code">
|
|
|
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 #if $advanced.choice == 'true':
|
|
|
26 --none ${advanced.None}
|
|
|
27 --pValue ${advanced.pValue}
|
|
|
28 --fChange ${advanced.fChange}
|
|
|
29 --generate_svg ${advanced.generateSvg}
|
|
|
30 --generate_pdf ${advanced.generatePdf}
|
|
|
31 --generate_ras ${advanced.generateRas}
|
|
|
32 #else
|
|
|
33 --none true
|
|
|
34 --pValue 0.05
|
|
|
35 --fChange 1.5
|
|
|
36 --generate_svg false
|
|
|
37 --generate_pdf true
|
|
|
38 --generate_ras false
|
|
|
39 #end if
|
|
|
40 --tool_dir $__tool_directory__
|
|
|
41 --option $cond.type_selector
|
|
|
42 --out_log $log
|
|
|
43
|
|
|
44 #if $cond.type_selector == 'datasets':
|
|
|
45 --input_datas
|
|
|
46 #for $data in $cond.input_Datasets:
|
|
|
47 ${data.input}
|
|
|
48 #end for
|
|
|
49 --names
|
|
|
50 #for $data in $cond.input_Datasets:
|
|
|
51 ${data.input_name}
|
|
|
52 #end for
|
|
|
53 #elif $cond.type_selector == 'dataset_class':
|
|
|
54 --input_data ${input_data}
|
|
|
55 --input_class ${input_class}
|
|
|
56 #end if
|
|
28
|
57 #if $cond.type_selector == 'datasets_rasonly':
|
|
|
58 --input_datas ${input_Datasets}
|
|
|
59 --single_ras_file $ras_single
|
|
|
60 #end if
|
|
16
|
61 ]]>
|
|
|
62 </command>
|
|
|
63
|
|
|
64 <inputs>
|
|
|
65 <conditional name="cond_rule">
|
|
|
66 <expand macro="options"/>
|
|
|
67 <when value="HMRcore">
|
|
|
68 </when>
|
|
|
69 <when value="Recon">
|
|
|
70 </when>
|
|
|
71 <when value="Custom">
|
|
|
72 <param name="Custom_rules" type="data" format="tabular, csv, tsv, xml" label="Custom rules" />
|
|
|
73 <conditional name="cond_map">
|
|
|
74 <param name="yes_no" type="select" label="Custom map? (optional)">
|
|
|
75 <option value="no" selected="true">no</option>
|
|
|
76 <option value="yes">yes</option>
|
|
|
77 </param>
|
|
|
78 <when value="yes">
|
|
|
79 <param name="Custom_map" argument="--custom_map" type="data" format="xml, svg" label="custom-map.svg"/>
|
|
|
80 </when>
|
|
|
81 <when value="no">
|
|
|
82 </when>
|
|
|
83 </conditional>
|
|
|
84 </when>
|
|
|
85 </conditional>
|
|
|
86 <conditional name="cond">
|
|
|
87 <param name="type_selector" argument="--option" type="select" label="Input format:">
|
|
|
88 <option value="datasets" selected="true">RNAseq of group 1 + RNAseq of group 2 + ... + RNAseq of group N</option>
|
|
|
89 <option value="dataset_class">RNAseq of all samples + sample group specification</option>
|
|
28
|
90 <option value="datasets_rasonly" selected="true">RNAseq dataset</option>
|
|
16
|
91 </param>
|
|
|
92 <when value="datasets">
|
|
|
93 <repeat name="input_Datasets" title="RNAseq" min="2">
|
|
|
94 <param name="input" argument="--input_datas" type="data" format="tabular, csv, tsv" label="add dataset" />
|
|
|
95 <param name="input_name" argument="--names" type="text" label="Dataset's name:" value="Dataset" help="Default: Dataset" />
|
|
|
96 </repeat>
|
|
|
97 </when>
|
|
28
|
98 <when value="datasets_rasonly">
|
|
|
99 <param name="input_Datasets" argument="--input_datas" type="data" format="tabular, csv, tsv" label="add dataset" />
|
|
|
100 </when>
|
|
16
|
101 <when value="dataset_class">
|
|
|
102 <param name="input_data" argument="--input_data" type="data" format="tabular, csv, tsv" label="RNAseq of all samples" />
|
|
|
103 <param name="input_class" argument="--input_class" type="data" format="tabular, csv, tsv" label="Sample group specification" />
|
|
|
104 </when>
|
|
|
105 </conditional>
|
|
|
106
|
|
28
|
107
|
|
|
108 <!--TODO: NASCONDERE ADVANCED SE RAS ONLY-->
|
|
|
109
|
|
16
|
110 <conditional name="advanced">
|
|
|
111 <param name="choice" type="boolean" checked="false" label="Use advanced options?" help="Use this options to choose custom rules for evaluation: pValue, Fold-Change threshold, how to solve (A and NaN) and specify output maps.">
|
|
|
112 <option value="true" selected="true">No</option>
|
|
|
113 <option value="false">Yes</option>
|
|
|
114 </param>
|
|
|
115 <when value="false">
|
|
|
116 </when>
|
|
|
117 <when value="true">
|
|
|
118 <param name="None" argument="--none" type="boolean" truevalue="true" falsevalue="false" checked="true" label="(A and NaN) solved as (A)?" />
|
|
|
119 <param name="pValue" argument="--pValue" type="float" size="20" value="0.05" max="1" min="0" label="P-value threshold:" help="min value 0" />
|
|
|
120 <param name="fChange" argument="--fChange" type="float" size="20" value="1.5" min="1" label="Fold-Change threshold:" help="min value 1" />
|
|
|
121 <param name="generateSvg" argument="--generateSvg" type="boolean" checked="false" label="Generate SVG map" help="should the program generate an editable svg map of the processes?" />
|
|
|
122 <param name="generatePdf" argument="--generatePdf" type="boolean" checked="true" label="Generate PDF map" help="should the program return a non editable (but displayble) pdf map of the processes?" />
|
|
|
123 <param name="generateRas" argument="--generateRas" type="boolean" checked="false" label="Generate Reaction Activity Score for each table" help="Generate Reaction Activity Score for each table" />
|
|
|
124 </when>
|
|
|
125 </conditional>
|
|
|
126 </inputs>
|
|
|
127
|
|
|
128 <outputs>
|
|
|
129 <data format="txt" name="log" label="${tool.name} - Log" />
|
|
28
|
130 <data format="tabular" name="ras_single" label="${tool.name} - RAS">
|
|
|
131 <filter>cond['type_selector'] == "datasets_rasonly"</filter>
|
|
|
132 </data>
|
|
16
|
133 <collection name="results" type="list" label="${tool.name} - Results">
|
|
28
|
134 <filter>cond['type_selector'] == "datasets" or cond['type_selector'] == "dataset_class"</filter>
|
|
16
|
135 <discover_datasets pattern="__name_and_ext__" directory="result"/>
|
|
|
136 </collection>
|
|
28
|
137 <collection name="ras" type="list" label="${tool.name} - RAS list" format_source="tabular">
|
|
16
|
138 <filter>advanced['choice'] and advanced['generateRas']</filter>
|
|
|
139 <discover_datasets pattern="__name_and_ext__" directory="ras" format="tabular"/>
|
|
|
140 </collection>
|
|
28
|
141
|
|
16
|
142 </outputs>
|
|
|
143 <tests>
|
|
|
144 <test>
|
|
|
145 <param name="pValue" value="0.56"/>
|
|
|
146 <output name="log" file="log.txt"/>
|
|
|
147 </test>
|
|
|
148 </tests>
|
|
|
149 <help>
|
|
|
150 <![CDATA[
|
|
|
151
|
|
|
152 What it does
|
|
|
153 -------------
|
|
|
154
|
|
|
155 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.
|
|
|
156
|
|
|
157 Accepted files are:
|
|
|
158 - 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*");
|
|
|
159 - option 2) one RNA dataset and one class-file specifying the class/condition each sample belongs to.
|
|
|
160
|
|
|
161 Optional files:
|
|
|
162 - custom GPR (Gene-Protein-Reaction) rules. Two accepted formats:
|
|
|
163
|
|
|
164 * (Cobra Toolbox and CobraPy compliant) xml of metabolic model;
|
|
|
165 * .csv file specifyig for each reaction ID (column 1) the corresponding GPR rule (column 2).
|
|
|
166 - custom svg map. Graphical elements must have the same IDs of reactions. See HmrCore svg map for an example.
|
|
|
167
|
|
|
168 The tool generates:
|
|
|
169 1) a tab-separated file: reporting fold-change and p-values of reaction activity scores (RASs) between a pair of conditions/classes;
|
|
|
170 2) a metabolic map file (downlodable as .svg): visualizing up- and down-regulated reactions between a pair of conditions/classes;
|
|
|
171 3) a log file (.txt).
|
|
|
172
|
|
|
173 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.
|
|
|
174
|
|
|
175 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).
|
|
|
176
|
|
|
177 To calculate P-Values and Fold-Changes and to generate maps, comparisons are performed for each possible pair of classes.
|
|
|
178
|
|
|
179 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".
|
|
|
180
|
|
|
181
|
|
|
182 Example input
|
|
|
183 -------------
|
|
|
184
|
|
|
185 **"Custom Rules"** option:
|
|
|
186
|
|
|
187 Custom Rules Dastaset:
|
|
|
188
|
|
|
189 @CUSTOM_RULES_EXEMPLE@
|
|
|
190
|
|
|
191 **"RNAseq of group 1 + RNAseq of group 2 + ... + RNAseq of group N"** option:
|
|
|
192
|
|
|
193 RNA-seq Dataset 1:
|
|
|
194
|
|
|
195 @DATASET_EXEMPLE1@
|
|
|
196
|
|
|
197 RNA-seq Dataset 2:
|
|
|
198
|
|
|
199 @DATASET_EXEMPLE2@
|
|
|
200
|
|
|
201 **"RNAseq of all samples + sample group specification"** option:
|
|
|
202
|
|
|
203 RNA-seq Dataset:
|
|
|
204
|
|
|
205 @DATASET_EXEMPLE1@
|
|
|
206
|
|
|
207 Class-file:
|
|
|
208
|
|
|
209 +------------+------------+
|
|
|
210 | Patient_ID | class |
|
|
|
211 +============+============+
|
|
|
212 | TCGAAA3529 | MSI |
|
|
|
213 +------------+------------+
|
|
|
214 | TCGAA62671 | MSS |
|
|
|
215 +------------+------------+
|
|
|
216 | TCGAA62672 | MSI |
|
|
|
217 +------------+------------+
|
|
|
218
|
|
|
219 |
|
|
|
220
|
|
|
221 .. class:: infomark
|
|
|
222
|
|
|
223 **TIP**: If your data is not TAB delimited, use `Convert delimiters to TAB`_.
|
|
|
224
|
|
|
225 .. class:: infomark
|
|
|
226
|
|
|
227 **TIP**: If your dataset is not split into classes, use `MaREA cluster analysis`_.
|
|
|
228
|
|
|
229 @REFERENCE@
|
|
|
230
|
|
|
231 .. _MaREA: https://www.biorxiv.org/content/early/2018/01/16/248724
|
|
|
232 .. _Convert delimiters to TAB: https://usegalaxy.org/?tool_id=Convert+characters1&version=1.0.0&__identifer=6t22teyofhj
|
|
|
233 .. _MaREA cluster analysis: http://link del tool di cluster.org
|
|
|
234
|
|
|
235 ]]>
|
|
|
236 </help>
|
|
|
237 <expand macro="citations" />
|
|
|
238 </tool>
|
|
|
239
|
