annotate macros.xml @ 0:7cda9aef13f3 draft

planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
author recetox
date Tue, 13 Dec 2022 13:26:29 +0000
parents
children 29fc1af350f5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
1 <macros>
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
2 <token name="@TOOL_VERSION@">3.5.2</token>
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
3 <xml name="requirements">
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
4 <requirements>
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
5 <container type="docker">recetox/recetox-msfinder:3.5.2-0</container>
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
6 </requirements>
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
7 </xml>
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
8 <xml name="creator">
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
9 <creator>
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
10 <person
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
11 givenName="Zargham"
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
12 familyName="Ahmad"
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
13 url="https://github.com/zargham-ahmad"
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
14 identifier="0000-0002-6096-224X" />
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
15 <organization
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
16 url="https://www.recetox.muni.cz/"
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
17 email="GalaxyToolsDevelopmentandDeployment@space.muni.cz"
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
18 name="RECETOX MUNI" />
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
19 </creator>
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
20 </xml>
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
21 <xml name="input">
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
22 <param name="input_data" type="data" format="msp" label="Input mass spectral library file to which to add peak annotations."
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
23 help="Formula and InChI (or SMILES) codes are required to be present in the library file" />
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
24 </xml>
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
25 <xml name="parameter">
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
26 <param type="float" value="0.01" name="Ms2Tolerance" label="Ms2Tolerance" help="The mass tolerance used for fragment peak matching and annotation." />
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
27 <param name="IsTmsMeoxDerivative" type="boolean" checked="False" truevalue="True" falsevalue="False" label="IsTmsMeoxDerivative"
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
28 help="Check TMS-MeOX derivative to use EIMS database; otherwise, MSMS database is used." />
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
29 <param type="integer" value="1" name="RelativeAbundanceCutOff" label="RelativeAbundanceCutOff"
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
30 help="Remove peaks with less than specified % relative intensity from the spectra." />
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
31 <param type="float" value="0.001" name="Ms1Tolerance" label="Ms1Tolerance" help="The precursor m/z tolerance to generate formula candidates." />
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
32 <param type="select" name="MassToleranceType" label="MassToleranceType" help="Da stands for Daltons (amu), and Ppm stands for parts per million">
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
33 <option value="Da" selected="True">Da</option>
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
34 <option value="Ppm">Ppm</option>
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
35 </param>
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
36 <param type="integer" value="-1" name="StructurePredictionTimeOut" label="StructurePredictionTimeOut" help="Time out parameter, value of -1 means no timeout" />
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
37 <param name="LewisAndSeniorCheck" type="boolean" checked="True" truevalue="True" falsevalue="False" label="LewisAndSeniorCheck"
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
38 help="Generate formula candidates that match the valence rules of formula elements." />
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
39 </xml>
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
40 <xml name="element_check_parameter">
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
41 <!-- Element Checks -->
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
42 <param name="Ocheck" type="boolean" checked="True" truevalue="True" falsevalue="False" label="Ocheck" />
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
43 <param name="Ncheck" type="boolean" checked="True" truevalue="True" falsevalue="False" label="Ncheck" />
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
44 <param name="Pcheck" type="boolean" checked="True" truevalue="True" falsevalue="False" label="Pcheck" />
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
45 <param name="Scheck" type="boolean" checked="True" truevalue="True" falsevalue="False" label="Scheck" />
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
46 <param name="Fcheck" type="boolean" checked="True" truevalue="True" falsevalue="False" label="Fcheck" />
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
47 <param name="ClCheck" type="boolean" checked="True" truevalue="True" falsevalue="False" label="ClCheck" />
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
48 <param name="BrCheck" type="boolean" checked="True" truevalue="True" falsevalue="False" label="BrCheck" />
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
49 <param name="Icheck" type="boolean" checked="True" truevalue="True" falsevalue="False" label="Icheck" />
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
50 <param name="SiCheck" type="boolean" checked="True" truevalue="True" falsevalue="False" label="SiCheck" />
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
51 </xml>
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
52 <xml name="output">
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
53 <data name="annotated_data" format="msp" />
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
54 </xml>
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
55
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
56 <token name="@HELP@"><![CDATA[
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
57 **Description**
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
58
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
59 MS-FINDER was launched as a universal program for compound annotation that supports EI-MS (GC/MS) and
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
60 MS/MS spectral mining. MS-FINDER provide solution for fragment annotations. The program can annotate
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
61 your unknowns by the public spectral databases such as MassBank, LipidBlast, and GNPS. MS-FINDER has
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
62 been developed as the collaborative work between Prof. Masanori Arita team (RIKEN, Reifycs Inc.) and
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
63 Prof. Oliver Fiehn team (UC Davis) supported by the JST/NSF SICORP Metabolomics for the low carbon society
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
64 project.
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
65
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
66 This galaxy wrapper only peforms MS2 peak annotation given a correctly formatted mass spectral library file.
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
67 FORMULA, PRECURSORMZ and SMILES (or INCHI) metadata entries are required to be present in the input mass spectral library file.
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
68 Each spectrum has to be separated by a single blank line.
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
69
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
70 For detailed documentation of the tool please visit https://mtbinfo-team.github.io/mtbinfo.github.io/MS-FINDER/tutorial
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
71 ]]>
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
72 </token>
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
73
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
74 <xml name="citations">
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
75 <citation type="doi">10.1021/acs.analchem.6b00770</citation>
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
76 </xml>
7cda9aef13f3 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/recetox_msfinder commit f655a81cc6289f228ee7f58dc6b3e2d9eb2dc923
recetox
parents:
diff changeset
77 </macros>