annotate macros.xml @ 3:b8b1b865c82d draft

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