Mercurial > repos > metexplore > met4j

annotate tools/networkAnalysis/SideCompoundsScan/SideCompoundsScan.xml @ 1:9b162ee6ff8e 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 12798951d21c3b2b13514b38148b2848cb422c95
author metexplore
date Mon, 27 Jun 2022 13:41:08 +0000
parents dcd16521b969
children e69a78624877
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
1 <?xml version="1.0" encoding="UTF-8"?>
1
9b162ee6ff8e planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 12798951d21c3b2b13514b38148b2848cb422c95
metexplore
parents: 0
diff changeset
2 <tool id="met4j_SideCompoundsScan" name="SideCompoundsScan" version="0.12.0">
0
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
3 <description>Scan a network to identify side-compounds.</description>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
4 <xrefs>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
5 <xref type="bio.tools">met4j</xref>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
6 </xrefs>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
7 <requirements>
1
9b162ee6ff8e planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 12798951d21c3b2b13514b38148b2848cb422c95
metexplore
parents: 0
diff changeset
8 <container type="singularity">oras://registry.forgemia.inra.fr/metexplore/met4j/met4j-singularity:0.12.0</container>
0
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
9 </requirements>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
10 <command detect_errors="exit_code"><![CDATA[sh /usr/bin/met4j.sh networkAnalysis.SideCompoundsScan -i "$inputPath"
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
11 $sideOnly
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
12 $noReportValue
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
13 #if str($degree):
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
14 -d "$degree"
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
15 #end if
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
16 #if str($degreePrecentile) != 'nan':
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
17 -dp "$degreePrecentile"
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
18 #end if
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
19 $flagInorganic
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
20 $flagNoFormula
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
21 #if str($parallelEdge) != 'nan':
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
22 -nc "$parallelEdge"
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
23 #end if
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
24 #if str($mergingStrat):
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
25 -m "$mergingStrat"
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
26 #end if
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
27 -o "$outputPath"
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
28 ]]></command>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
29 <inputs>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
30 <param argument="-i" format="sbml" label="input SBML file" name="inputPath" optional="false" type="data" value=""/>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
31 <param argument="-s" checked="false" falsevalue="" label="output compounds flagged as side-Compounds only" name="sideOnly" truevalue="-s" type="boolean" value="false"/>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
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"/>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
33 <param argument="-d" label="flag as side compounds any compounds with degree above threshold" name="degree" optional="true" type="text" value="400">
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
34 <sanitizer invalid_char="_">
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
35 <valid initial="string.printable"/>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
36 </sanitizer>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
37 </param>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
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"/>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
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"/>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
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"/>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
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"/>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
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">
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
43 <option selected="true" value="no">no</option>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
44 <option value="by_name">by_name</option>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
45 <option value="by_id">by_id</option>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
46 </param>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
47 </inputs>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
48 <outputs>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
49 <data format="tsv" name="outputPath"/>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
50 </outputs>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
51 <tests>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
52 <test>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
53 <param name="inputPath" value="XF_network.sbml"/>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
54 <output ftype="tsv" name="outputPath">
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
55 <assert_contents>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
56 <has_n_lines n="1108"/>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
57 <has_n_columns n="4"/>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
58 </assert_contents>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
59 </output>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
60 </test>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
61 <test>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
62 <param name="inputPath" value="XF_network.sbml"/>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
63 <param name="noReportValue" value="true"/>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
64 <output ftype="tsv" name="outputPath">
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
65 <assert_contents>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
66 <has_n_lines n="6"/>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
67 <has_n_columns n="1"/>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
68 </assert_contents>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
69 </output>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
70 </test>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
71 </tests>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
72 <help><![CDATA[Scan a network to identify side-compounds.
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
73 Side compounds are metabolites of small relevance for topological analysis. Their definition can be quite subjective and varies between sources.
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
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.
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
75 This tool attempts to propose a list of side compounds according to specific criteria:
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
76 - *Degree*: Compounds with an uncommonly high number of neighbors can betray a lack of process specificity.
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
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
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
78 - *Neighbor Coupling*: Similar to degree, this criteria assume that side compounds are involved in many reactions, but in pairs with other side compounds.
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
79 Therefore, the transition from ATP to ADP will appear multiple time in the network, creating redundant 'parallel edges' between these two neighbors.
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
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.
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
81 - *Carbon Count*: Metabolic "waste", or degradation end-product such as ammonia or carbon dioxide are usually considered as side compounds.
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
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>
1
9b162ee6ff8e planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 12798951d21c3b2b13514b38148b2848cb422c95
metexplore
parents: 0
diff changeset
83 <citations/>
0
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
84 </tool>