Mercurial > repos > metexplore > met4j

comparison build/tools/SideCompoundsScan/SideCompoundsScan.xml @ 9:0976a6257300 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 05db35f63cadb9d56dafff594a3507c59cd85273
author metexplore
date Fri, 31 Jan 2025 18:28:53 +0000
parents 1274e2a62479
children 6a112eaf8f38
comparison
equal deleted inserted replaced
8:1274e2a62479 9:0976a6257300
1 <?xml version="1.0" encoding="UTF-8"?> 1 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
2 <tool id="met4j_SideCompoundsScan" name="SideCompoundsScan" version="1.5.0"> 2 <tool id="met4j_SideCompoundsScan" name="SideCompoundsScan" version="develop">
3 <description>Scan a network to identify side-compounds.</description> 3 <description>Scan a network to identify side compounds.</description>
4 <xrefs> 4 <xrefs>
5 <xref type="bio.tools">met4j</xref> 5 <xref type="bio.tools">met4j</xref>
6 </xrefs> 6 </xrefs>
7 <requirements> 7 <requirements>
8 <container type="singularity">oras://registry.forgemia.inra.fr/metexplore/met4j/met4j-singularity:1.5.0</container> 8 <container type="singularity">oras://registry.forgemia.inra.fr/metexplore/met4j/met4j-singularity:develop</container>
9 </requirements> 9 </requirements>
10 <command detect_errors="exit_code"><![CDATA[sh /usr/bin/met4j.sh networkAnalysis.SideCompoundsScan -i "$inputPath" 10 <command detect_errors="exit_code"><![CDATA[sh /usr/bin/met4j.sh networkAnalysis.SideCompoundsScan -i "$inputPath"
11 $sideOnly 11 $sideOnly
12 $noReportValue 12 $noReportValue
13 #if str($degree): 13 #if str($degree):
26 #end if 26 #end if
27 -o "$outputPath" 27 -o "$outputPath"
28 ]]></command> 28 ]]></command>
29 <inputs> 29 <inputs>
30 <param argument="-i" format="sbml" label="input SBML file" name="inputPath" optional="false" type="data" value=""/> 30 <param argument="-i" format="sbml" label="input SBML file" name="inputPath" optional="false" type="data" value=""/>
31 <param argument="-s" checked="false" falsevalue="" label="output compounds flagged as side-Compounds only" name="sideOnly" truevalue="-s" type="boolean" value="false"/> 31 <param argument="-s" checked="false" falsevalue="" label="output compounds flagged as side compounds only" name="sideOnly" truevalue="-s" type="boolean" value="false"/>
32 <param argument="-id" checked="false" falsevalue="" label="do not report values in output, export ids list of compounds flagged as side-Compounds, allowing piping results" name="noReportValue" truevalue="-id" type="boolean" value="false"/> 32 <param argument="-id" checked="false" falsevalue="" label="do not report values in output, export ids of compounds flagged as side compounds, allowing piping results" name="noReportValue" truevalue="-id" type="boolean" value="false"/>
33 <param argument="-d" label="flag as side compounds any compounds with degree above threshold" name="degree" optional="true" type="text" value="400"> 33 <param argument="-d" label="flag as side compounds any compound with degree above threshold" name="degree" optional="true" type="text" value="400">
34 <sanitizer invalid_char="_"> 34 <sanitizer invalid_char="_">
35 <valid initial="string.printable"/> 35 <valid initial="string.printable"/>
36 </sanitizer> 36 </sanitizer>
37 </param> 37 </param>
38 <param argument="-dp" label="flag as side compounds the top x% of compounds according to their degree" name="degreePrecentile" optional="true" type="float" value="NaN"/> 38 <param argument="-dp" label="flag as side compounds the top x% of compounds according to their degree" name="degreePrecentile" optional="true" type="float" value="NaN"/>
39 <param argument="-cc" checked="false" falsevalue="" label="flag as side compound any compounds with less than 2 carbons in formula" name="flagInorganic" truevalue="-cc" type="boolean" value="false"/> 39 <param argument="-cc" checked="false" falsevalue="" label="flag as side compound any compound with less than 2 carbons in formula" name="flagInorganic" truevalue="-cc" type="boolean" value="false"/>
40 <param argument="-uf" checked="false" falsevalue="" label="flag as side compound any compounds with no valid chemical formula" name="flagNoFormula" truevalue="-uf" type="boolean" value="false"/> 40 <param argument="-uf" checked="false" falsevalue="" label="flag as side compound any compound with no valid chemical formula" name="flagNoFormula" truevalue="-uf" type="boolean" value="false"/>
41 <param argument="-nc" label="flag as side compound any compound with a number of parallel edges shared with a neighbor above the given threshold" name="parallelEdge" optional="true" type="float" value="NaN"/> 41 <param argument="-nc" label="flag as side compound any compound with a number of parallel edges shared with a neighbor above the given threshold" name="parallelEdge" optional="true" type="float" value="NaN"/>
42 <param argument="-m" label="Degree is shared between compounds in different compartments. Use names if consistent and unambiguous across compartments, or identifiers if compartment suffix is present (id in form &quot;xxx_y&quot; with xxx as base identifier and y as compartment label)." name="mergingStrat" optional="true" type="select" value="no"> 42 <param argument="-m" label="degree is shared between compounds in different compartments. Use names if consistent and unambiguous across compartments, or identifiers if compartment suffix is present (id in form &quot;xxx_y&quot; with xxx as base identifier and y as compartment label)." name="mergingStrat" optional="true" type="select" value="no">
43 <option selected="true" value="no">no</option> 43 <option selected="true" value="no">no</option>
44 <option value="by_name">by_name</option> 44 <option value="by_name">by_name</option>
45 <option value="by_id">by_id</option> 45 <option value="by_id">by_id</option>
46 </param> 46 </param>
47 </inputs> 47 </inputs>
48 <outputs> 48 <outputs>
49 <data format="tsv" name="outputPath"/> 49 <data format="tsv" name="outputPath"/>
50 </outputs> 50 </outputs>
51 <tests> 51 <tests>
52 <test> 52 <test>
53
54
55
56
57
58
59
60
61
62
63
53 <param name="inputPath" value="XF_network.sbml"/> 64 <param name="inputPath" value="XF_network.sbml"/>
65
66
67
68
69
70
71
72
73
74
75
54 <output ftype="tsv" name="outputPath"> 76 <output ftype="tsv" name="outputPath">
77
78
79
80
81
82
83
84
85
86
87
55 <assert_contents> 88 <assert_contents>
89
90
91
92
93
94
95
96
97
98
99
56 <has_n_lines n="1108"/> 100 <has_n_lines n="1108"/>
101
102
103
104
105
106
107
108
109
110
111
57 <has_n_columns n="4"/> 112 <has_n_columns n="4"/>
113
114
115
116
117
118
119
120
121
122
123
58 </assert_contents> 124 </assert_contents>
125
126
127
128
129
130
131
132
133
134
135
59 </output> 136 </output>
137
138
139
140
141
142
143
144
145
146
147
60 </test> 148 </test>
61 <test> 149 <test>
150
151
152
153
154
155
156
157
158
159
160
62 <param name="inputPath" value="XF_network.sbml"/> 161 <param name="inputPath" value="XF_network.sbml"/>
162
163
164
165
166
167
168
169
170
171
172
63 <param name="noReportValue" value="true"/> 173 <param name="noReportValue" value="true"/>
174
175
176
177
178
179
180
181
182
183
184
64 <output ftype="tsv" name="outputPath"> 185 <output ftype="tsv" name="outputPath">
186
187
188
189
190
191
192
193
194
195
196
65 <assert_contents> 197 <assert_contents>
198
199
200
201
202
203
204
205
206
207
208
66 <has_n_lines n="6"/> 209 <has_n_lines n="6"/>
210
211
212
213
214
215
216
217
218
219
220
67 <has_n_columns n="1"/> 221 <has_n_columns n="1"/>
222
223
224
225
226
227
228
229
230
231
232
68 </assert_contents> 233 </assert_contents>
234
235
236
237
238
239
240
241
242
243
244
69 </output> 245 </output>
246
247
248
249
250
251
252
253
254
255
256
70 </test> 257 </test>
71 </tests> 258 </tests>
72 <help><![CDATA[Scan a network to identify side-compounds. 259 <help><![CDATA[Scan a network to identify side compounds.
73 Side compounds are metabolites of small relevance for topological analysis. Their definition can be quite subjective and varies between sources. 260 Side compounds are metabolites of small relevance for topological analysis. Their definition can be quite subjective and varies between sources.
74 Side compounds tend to be ubiquitous and not specific to a particular biochemical or physiological process.Compounds usually considered as side compounds include water, atp or carbon dioxide. By being involved in many reactions and thus connected to many compounds, they tend to significantly lower the average shortest path distances beyond expected metabolic relatedness. 261 Side compounds tend to be ubiquitous and not specific to a particular biochemical or physiological process.Compounds usually considered as side compounds include water, atp or carbon dioxide. By being involved in many reactions and thus connected to many compounds, they tend to significantly lower the average shortest path distances beyond expected metabolic relatedness.
75 This tool attempts to propose a list of side compounds according to specific criteria: 262 This tool attempts to propose a list of side compounds according to specific criteria:
76 - *Degree*: Compounds with an uncommonly high number of neighbors can betray a lack of process specificity. 263 - *Degree*: Compounds with an uncommonly high number of neighbors can betray a lack of process specificity.
77 High degree compounds typically include water and most main cofactors (CoA, ATP, NADPH...) but can also include central compounds such as pyruvate or acetyl-CoA 264 High degree compounds typically include water and most main cofactors (CoA, ATP, NADPH...) but can also include central compounds such as pyruvate or acetyl-CoA
78 - *Neighbor Coupling*: Similar to degree, this criteria assume that side compounds are involved in many reactions, but in pairs with other side compounds. 265 - *Neighbor Coupling*: Similar to degree, this criteria assume that side compounds are involved in many reactions, but in pairs with other side compounds.
79 Therefore, the transition from ATP to ADP will appear multiple time in the network, creating redundant 'parallel edges' between these two neighbors. 266 Therefore, the transition from ATP to ADP will appear multiple times in the network, creating redundant 'parallel edges' between these two neighbors.
80 Being tightly coupled to another compound through a high number of redundant edges, can point out cofactors while keeping converging pathways' products with high degree like pyruvate aside. 267 Being tightly coupled to another compound through a high number of redundant edges, can point out cofactors while keeping converging pathways' products with high degree like pyruvate aside.
81 - *Carbon Count*: Metabolic "waste", or degradation end-product such as ammonia or carbon dioxide are usually considered as side compounds. 268 - *Carbon Count*: Metabolic "waste", or degradation end-product such as ammonia or carbon dioxide are usually considered as side compounds.
82 Most of them are inorganic compound, another ill-defined concept, sometimes defined as compound lacking C-C or C-H bonds. Since chemical structure is rarely available in SBML model beyond chemical formula, we use a less restrictive criterion by flagging compound with one or no carbons. This cover most inorganic compounds, but include few compounds such as methane usually considered as organic. - *Chemical Formula*: Metabolic network often contains 'artifacts' that serve modelling purpose (to define a composite objective function for example). Such entities can be considered as 'side entities'. Since they are not actual chemical compounds, they can be detected by their lack of valid chemical formula. However, this can also flag main compounds with erroneous or missing annotation.]]></help> 269 Most of them are inorganic compound, another ill-defined concept, sometimes defined as compound lacking C-C or C-H bonds. Since chemical structure is rarely available in SBML model beyond chemical formula, we use a less restrictive criterion by flagging compound with one or no carbons. This cover most inorganic compounds, but include few compounds such as methane usually considered as organic. - *Chemical Formula*: Metabolic network often contains 'artifacts' that serve modelling purpose (to define a composite objective function for example). Such entities can be considered as 'side entities'. Since they are not actual chemical compounds, they can be detected by their lack of valid chemical formula. However, this can also flag main compounds with erroneous or missing annotation.]]></help>
83 <citations/> 270 <citations/>
84 </tool> 271 </tool>