annotate MS/query_mass_repos.xml @ 25:9f03c8587d6b draft default tip

MetExp msclust upload format changed from tabular to csv
author linda-bakker
date Fri, 24 Aug 2018 09:56:05 -0400
parents 5a753524e525
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
1 <tool id="query_mass_repos"
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
2 name="METEXP - Find elemental composition formulas based on mass values "
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
3 version="0.1.0">
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
4 <description>Query multiple public repositories for elemental compositions from accurate mass values detected by high-resolution mass spectrometers</description>
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
5 <command interpreter="python">
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
6 query_mass_repos.py
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
7 $input_file
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
8 "$molecular_mass_col"
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
9 "$repository_file"
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
10 $error_margin
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
11 $margin_unit
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
12 $output_result
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
13 </command>
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
14 <inputs>
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
15
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
16 <param name="input_file" format="tabular" type="data"
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
17 label="Input file"
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
18 help="Select a tabular file containing the entries to be queried/verified in the MetExp DB"/>
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
19
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
20 <param name="molecular_mass_col" type="text" size="50"
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
21 label="Molecular mass column name"
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
22 value="MM"
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
23 help="Name of the column containing the molecular mass information (in the given input file)" />
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
24
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
25 <param name="repository_file" type="select" label="Repository/service to query"
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
26 help="Select the repository/service which should be queried"
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
27 dynamic_options='get_directory_files("tool-data/shared/PRIMS-metabolomics/MetExp_MassSearch_Services")'/>
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
28
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
29 <param name="error_margin" type="float" size="10"
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
30 label="Error marging"
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
31 value="0.01"
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
32 help="Mass difference allowed when searching in the repositories for a mass match." />
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
33
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
34 <param name="margin_unit" type="select" label="Margin unit">
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
35 <option value="ms" selected="True">ms</option>
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
36 <option value="ppm">ppm</option>
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
37 </param>
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
38 <!-- TODO
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
39 <param name="metexp_access_key" type="text" size="50"
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
40 label="(Optional)MetExp access key"
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
41 value=""
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
42 help="Key needed to get access to MetExp services. Fill in if MetExp service was selected" /> -->
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
43
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
44 </inputs>
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
45 <outputs>
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
46 <data name="output_result" format="tabular" label="${tool.name} on ${on_string}" />
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
47 </outputs>
13
5a753524e525 fix for match_library
pieter.lukasse@wur.nl
parents: 6
diff changeset
48 <code file="../match_library.py" /> <!-- file containing get_directory_files function used above-->
6
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
49 <help>
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
50 .. class:: infomark
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
51
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
52 This tool will query multiple public repositories such as PRI-MetExp or http://webs2.kazusa.or.jp/mfsearcher
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
53 for elemental compositions from accurate mass values detected by high-resolution mass spectrometers.
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
54
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
55 It will take the input file and for each record it will query the
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
56 molecular mass in the selected repository. If one or more compounds are found in the
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
57 repository then extra information regarding (mass based)matching elemental composition formulas is added to the output file.
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
58
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
59 The output file is thus the input file enriched with information about
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
60 related items found in the selected repository.
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
61
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
62 **Notes**
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
63
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
64 The input file can be any tabular file, as long as it contains a column for the molecular mass.
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
65
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
66 **Services that can be queried**
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
67
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
68 ================= =========================================================================
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
69 Database Description
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
70 ----------------- -------------------------------------------------------------------------
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
71 PRI-MetExp LC-MS and GC-MS data from experiments from the metabolomics group at
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
72 Plant Research International. NB: restricted access to employees with
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
73 access key.
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
74 ExactMassDB A database of possible elemental compositions consits of C: 100,
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
75 H: 200, O: 50, N: 10, P: 10, and S: 10, that satisfy the Senior and
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
76 the Lewis valence rules.
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
77 (via /mfsearcher/exmassdb/)
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
78 ExactMassDB-HR2 HR2, which is one of the fastest tools for calculation of elemental
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
79 compositions, filters some elemental compositions according to
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
80 the Seven Golden Rules (Kind and Fiehn, 2007). The ExactMassDB-HR2
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
81 database returns the same result as does HR2 with the same atom kind
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
82 and number condition as that used in construction of the ExactMassDB.
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
83 (via /mfsearcher/exmassdb-hr2/)
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
84 Pep1000 A database of possible linear polypeptides that are
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
85 constructed with 20 kinds of amino acids and having molecular
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
86 weights smaller than 1000.
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
87 (via /mfsearcher/pep1000/)
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
88 KEGG Re-calculated compound data from KEGG. Weekly updated.
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
89 (via /mfsearcher/kegg/)
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
90 KNApSAcK Re-calculated compound data from KNApSAcK.
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
91 (via /mfsearcher/knapsack/)
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
92 Flavonoid Viewer Re-calculated compound data from Flavonoid Viewer .
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
93 (via /mfsearcher/flavonoidviewer/
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
94 LipidMAPS Re-calculated compound data from LIPID MAPS.
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
95 (via /mfsearcher/lipidmaps/)
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
96 HMDB Re-calculated compound data from Human Metabolome Database (HMDB)
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
97 Version 3.5.
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
98 (via /mfsearcher/hmdb/)
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
99 PubChem Re-calculated compound data from PubChem. Monthly updated.
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
100 (via /mfsearcher/pubchem/)
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
101 ================= =========================================================================
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
102
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
103 Sources for table above: PRI-MetExp and http://webs2.kazusa.or.jp/mfsearcher
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
104
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
105 </help>
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
106 </tool>