annotate macros.xml @ 4:464c1e80a01f draft

"planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit 9bc547872c98a9c13c561d15e8990fe82bdc0e72"
author recetox
date Fri, 28 Jan 2022 16:27:30 +0000
parents 94209fea0a99
children a393c4383436
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>
3
94209fea0a99 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit 2c173d0e31d016311ee2d73c468818b776a423b4"
recetox
parents: 2
diff changeset
8 <xml name="creator">
94209fea0a99 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit 2c173d0e31d016311ee2d73c468818b776a423b4"
recetox
parents: 2
diff changeset
9 <creator>
4
464c1e80a01f "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit 9bc547872c98a9c13c561d15e8990fe82bdc0e72"
recetox
parents: 3
diff changeset
10 <person
464c1e80a01f "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit 9bc547872c98a9c13c561d15e8990fe82bdc0e72"
recetox
parents: 3
diff changeset
11 givenName="Jiří"
464c1e80a01f "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit 9bc547872c98a9c13c561d15e8990fe82bdc0e72"
recetox
parents: 3
diff changeset
12 familyName="Novotný"
464c1e80a01f "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit 9bc547872c98a9c13c561d15e8990fe82bdc0e72"
recetox
parents: 3
diff changeset
13 url="https://github.com/xtracko"
464c1e80a01f "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit 9bc547872c98a9c13c561d15e8990fe82bdc0e72"
recetox
parents: 3
diff changeset
14 identifier="0000-0001-5449-3523" />
464c1e80a01f "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit 9bc547872c98a9c13c561d15e8990fe82bdc0e72"
recetox
parents: 3
diff changeset
15 <person
464c1e80a01f "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit 9bc547872c98a9c13c561d15e8990fe82bdc0e72"
recetox
parents: 3
diff changeset
16 givenName="Martin"
464c1e80a01f "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit 9bc547872c98a9c13c561d15e8990fe82bdc0e72"
recetox
parents: 3
diff changeset
17 familyName="Čech"
464c1e80a01f "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit 9bc547872c98a9c13c561d15e8990fe82bdc0e72"
recetox
parents: 3
diff changeset
18 url="https://github.com/martenson"
464c1e80a01f "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit 9bc547872c98a9c13c561d15e8990fe82bdc0e72"
recetox
parents: 3
diff changeset
19 identifier="0000-0002-9318-1781" />
3
94209fea0a99 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit 2c173d0e31d016311ee2d73c468818b776a423b4"
recetox
parents: 2
diff changeset
20 <organization
94209fea0a99 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit 2c173d0e31d016311ee2d73c468818b776a423b4"
recetox
parents: 2
diff changeset
21 url="https://www.recetox.muni.cz/"
4
464c1e80a01f "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit 9bc547872c98a9c13c561d15e8990fe82bdc0e72"
recetox
parents: 3
diff changeset
22 email="GalaxyToolsDevelopmentandDeployment@space.muni.cz"
3
94209fea0a99 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit 2c173d0e31d016311ee2d73c468818b776a423b4"
recetox
parents: 2
diff changeset
23 name="RECETOX MUNI" />
94209fea0a99 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit 2c173d0e31d016311ee2d73c468818b776a423b4"
recetox
parents: 2
diff changeset
24 </creator>
94209fea0a99 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit 2c173d0e31d016311ee2d73c468818b776a423b4"
recetox
parents: 2
diff changeset
25 </xml>
2
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
26 <xml name="inputs">
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
27 <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
28 <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
29 <help><![CDATA[
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
30 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
31 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
32 ]]></help>
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
33 </param>
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
34 <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
35 <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
36 <help><![CDATA[
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
37 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
38 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
39 ]]></help>
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
40 </param>
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
41 <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
42 <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
43 <help><![CDATA[
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
44 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
45 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
46 ]]></help>
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
47 </param>
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
48 </xml>
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
49
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
50 <xml name="outputs">
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
51 <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
52 </xml>
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
53
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
54 <xml name="tolerance">
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
55 <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
56 <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
57 <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
58 </param>
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
59 <yield/>
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
60 </xml>
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
61 <token name="@HELP@">
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
62 <![CDATA[
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
63 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
64 using advanced methods.
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
65
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
66 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
67 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
68 withing some tolerance.
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
69 ]]>
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
70 </token>
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
71 <xml name="citations">
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
72 <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
73 </xml>
7807fbeb1388 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox-xmsannotator commit e547915248546657de13b91f28e5f4488ae8f7e0"
recetox
parents:
diff changeset
74 </macros>