annotate METEXPtools/query_metexp.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_metexp"
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
2 name="METEXP - Query Database "
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 a set of identifications against the METabolomics EXPeriments database</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_metexp.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 "$casid_col"
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
9 "$formula_col"
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
10 "$molecular_mass_col"
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
11 "$metexp_dblink_file"
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
12 $separation_method
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
13 $output_result
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
14 </command>
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
15 <inputs>
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
16
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
17 <param name="input_file" format="tabular" type="data"
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
18 label="Input file"
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
19 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
20
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
21 <param name="separation_method" type="select" label="Data type to query">
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
22 <option value="GC" selected="True">GC</option>
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
23 <option value="LC">LC</option>
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
24 </param>
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
25
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
26
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
27 <param name="casid_col" type="text" size="50"
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
28 label="CAS ID column name"
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
29 value="CAS"
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
30 help="Name of the column containing the CAS code information (in the given input file)" />
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
31 <param name="formula_col" type="text" size="50"
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
32 label="Formula ID column name"
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
33 value="FORMULA"
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
34 help="Name of the column containing the formula information (in the given input file)" />
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
35 <param name="molecular_mass_col" type="text" size="50"
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
36 label="Molecular mass column name"
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
37 value="MM"
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
38 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
39
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
40 <param name="metexp_dblink_file" type="select" label="MetExp DB to query"
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
41 help="Select the MetExp Database/backend which should be queried"
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
42 dynamic_options='get_directory_files("tool-data/shared/PRIMS-metabolomics/MetExp_Databases")'/>
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
43
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
44
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
45 </inputs>
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
46 <outputs>
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
47 <data name="output_result" format="tabular" label="${tool.name} on ${on_string}" />
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
48 </outputs>
13
5a753524e525 fix for match_library
pieter.lukasse@wur.nl
parents: 6
diff changeset
49 <code file="../match_library.py" /> <!-- file containing get_directory_files function used above-->
6
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
50 <help>
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
51 .. class:: infomark
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
52
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
53 This tool will Query a set of identifications against the METabolomics EXPlorer database.
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 MetExp DB. If one or more compounds are found in the
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
57 MetExp DB then extra information regarding these compounds 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 MetExp DB.
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 and one for the formula of the respective identification.
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
66
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
67
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
68 </help>
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
69 </tool>