Mercurial > repos > metexplore > met4j

annotate build/tools/SideCompoundsScan/SideCompoundsScan.xml @ 8:1274e2a62479 draft default tip

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 e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
author metexplore
date Wed, 26 Jul 2023 15:33:45 +0000
parents 1436e9cde9c9
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
1 <?xml version="1.0" encoding="UTF-8"?>
8
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents: 7
diff changeset
2 <tool id="met4j_SideCompoundsScan" name="SideCompoundsScan" version="1.5.0">
6
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
3 <description>Scan a network to identify side-compounds.</description>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
4 <xrefs>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
5 <xref type="bio.tools">met4j</xref>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
6 </xrefs>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
7 <requirements>
8
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents: 7
diff changeset
8 <container type="singularity">oras://registry.forgemia.inra.fr/metexplore/met4j/met4j-singularity:1.5.0</container>
6
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
9 </requirements>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
10 <command detect_errors="exit_code"><![CDATA[sh /usr/bin/met4j.sh networkAnalysis.SideCompoundsScan -i "$inputPath"
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
11 $sideOnly
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
12 $noReportValue
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
13 #if str($degree):
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
14 -d "$degree"
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
15 #end if
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
16 #if str($degreePrecentile) != 'nan':
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
17 -dp "$degreePrecentile"
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
18 #end if
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
19 $flagInorganic
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
20 $flagNoFormula
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
21 #if str($parallelEdge) != 'nan':
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
22 -nc "$parallelEdge"
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
23 #end if
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
24 #if str($mergingStrat):
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
25 -m "$mergingStrat"
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
26 #end if
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
27 -o "$outputPath"
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
28 ]]></command>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
29 <inputs>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
30 <param argument="-i" format="sbml" label="input SBML file" name="inputPath" optional="false" type="data" value=""/>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
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"/>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
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"/>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
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">
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
34 <sanitizer invalid_char="_">
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
35 <valid initial="string.printable"/>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
36 </sanitizer>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
37 </param>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
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"/>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
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"/>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
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"/>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
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"/>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
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">
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
43 <option selected="true" value="no">no</option>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
44 <option value="by_name">by_name</option>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
45 <option value="by_id">by_id</option>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
46 </param>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
47 </inputs>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
48 <outputs>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
49 <data format="tsv" name="outputPath"/>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
50 </outputs>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
51 <tests>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
52 <test>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
53 <param name="inputPath" value="XF_network.sbml"/>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
54 <output ftype="tsv" name="outputPath">
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
55 <assert_contents>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
56 <has_n_lines n="1108"/>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
57 <has_n_columns n="4"/>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
58 </assert_contents>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
59 </output>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
60 </test>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
61 <test>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
62 <param name="inputPath" value="XF_network.sbml"/>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
63 <param name="noReportValue" value="true"/>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
64 <output ftype="tsv" name="outputPath">
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
65 <assert_contents>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
66 <has_n_lines n="6"/>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
67 <has_n_columns n="1"/>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
68 </assert_contents>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
69 </output>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
70 </test>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
71 </tests>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
72 <help><![CDATA[Scan a network to identify side-compounds.
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
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.
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
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.
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
75 This tool attempts to propose a list of side compounds according to specific criteria:
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
76 - *Degree*: Compounds with an uncommonly high number of neighbors can betray a lack of process specificity.
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
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
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
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.
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
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.
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
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.
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
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.
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
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>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
83 <citations/>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
84 </tool>