annotate macros.xml @ 2:7807fbeb1388 draft

"planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
author recetox
date Thu, 12 Aug 2021 11:12:59 +0000
parents
children 94209fea0a99
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
1 <macros>
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
2 <token name="@TOOL_VERSION@">0.9.0</token>
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
3 <xml name="requirements">
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
4 <requirements>
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
5 <requirement type="package" version="0.9.0">r-recetox-xmsannotator</requirement>
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
6 </requirements>
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
7 </xml>
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
8
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
9 <xml name="inputs">
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
10 <param name="peak_table" type="data" format="csv,h5,parquet">
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
11 <label>Peak table</label>
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
12 <help><![CDATA[
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
13 A peak-intensity table such as outputted from apLCMS.
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
14 The file is required to contain the fields <em>mz</em> and <em>rt</em>.
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
15 ]]></help>
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
16 </param>
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
17 <param name="compound_table" type="data" format="csv,parquet">
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
18 <label>Compound database</label>
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
19 <help><![CDATA[
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
20 Database of compounds according to which the annotation is performed.
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
21 The database is required to contain the fields <em>compound_id</em>, <em>monoisotopic_mass</em>, and <em>molecular_formula</em>.
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
22 ]]></help>
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
23 </param>
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
24 <param name="adduct_table" type="data" format="csv,parquet" optional="true">
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
25 <label>Adduct database (optional)</label>
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
26 <help><![CDATA[
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
27 Database of adduct which is combined with the database of compound to form a molecule-adduct pairs.
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
28 The database is required to contain <em>adduct</em>, <em>charge</em>, <em>mass</em>, and <em>n_molecules</em>.
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
29 ]]></help>
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
30 </param>
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
31 </xml>
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
32
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
33 <xml name="outputs">
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
34 <data name="annotation_parquet" format="parquet"/>
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
35 </xml>
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
36
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
37 <xml name="tolerance">
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
38 <param name="mass_tolerance_ppm" type="integer" min="0" value="5">
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
39 <label>Mass tolerance [ppm]</label>
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
40 <help>Mass tolerance in ppm for database matching.</help>
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
41 </param>
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
42 <yield/>
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
43 </xml>
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
44 <token name="@HELP@">
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
45 <![CDATA[
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
46 Annotate the peak intensity table (e.g. from an apLCMS run) with compounds from the compounds database
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
47 using advanced methods.
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
48
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
49 The annotation process generates all possible compound-adduct pairs and matches those pairs to the measured
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
50 peaks. A compound-adduct pair is pronounced as a match to a certain peak when the difference of their masses are
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
51 withing some tolerance.
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
52 ]]>
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
53 </token>
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
54 <xml name="citations">
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
55 <citation type="doi">10.1021/acs.analchem.6b01214</citation>
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
56 </xml>
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
57 </macros>