annotate macros.xml @ 0:e2e2e455fcfb draft

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