annotate AccurateMassSearch.xml @ 1:e37e8ba1b4b7 draft

Uploaded
author bgruening
date Thu, 16 Apr 2015 09:01:52 -0400
parents 3070d71e0e5c
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
1 <?xml version='1.0' encoding='UTF-8'?>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
2 <tool id="AccurateMassSearch" name="AccurateMassSearch" version="2.0.0">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
3 <description>Find potential HMDB ids within the given mass error window.</description>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
4 <macros>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
5 <token name="@EXECUTABLE@">AccurateMassSearch</token>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
6 <import>macros.xml</import>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
7 </macros>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
8 <expand macro="stdio"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
9 <expand macro="requirements"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
10 <command>AccurateMassSearch
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
11
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
12 #if $param_in:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
13 -in $param_in
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
14 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
15 #if $param_out:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
16 -out $param_out
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
17 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
18 #if $param_out_annotation:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
19 -out_annotation $param_out_annotation
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
20 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
21 #if $param_positive_adducts_file:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
22 -positive_adducts_file $param_positive_adducts_file
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
23 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
24 #if $param_negative_adducts_file:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
25 -negative_adducts_file $param_negative_adducts_file
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
26 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
27 -threads \${GALAXY_SLOTS:-24}
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
28 #if $param_db_mapping:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
29 -db:mapping $param_db_mapping
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
30 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
31 #if $param_db_struct:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
32 -db:struct $param_db_struct
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
33 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
34 #if $param_algorithm_mass_error_value:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
35 -algorithm:mass_error_value $param_algorithm_mass_error_value
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
36 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
37 #if $param_algorithm_mass_error_unit:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
38 -algorithm:mass_error_unit
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
39 #if " " in str($param_algorithm_mass_error_unit):
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
40 "$param_algorithm_mass_error_unit"
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
41 #else
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
42 $param_algorithm_mass_error_unit
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
43 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
44 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
45 #if $param_algorithm_ionization_mode:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
46 -algorithm:ionization_mode
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
47 #if " " in str($param_algorithm_ionization_mode):
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
48 "$param_algorithm_ionization_mode"
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
49 #else
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
50 $param_algorithm_ionization_mode
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
51 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
52 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
53 #if $param_algorithm_isotopic_similarity:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
54 -algorithm:isotopic_similarity
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
55 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
56 #if $param_algorithm_report_mode:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
57 -algorithm:report_mode
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
58 #if " " in str($param_algorithm_report_mode):
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
59 "$param_algorithm_report_mode"
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
60 #else
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
61 $param_algorithm_report_mode
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
62 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
63 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
64 #if $param_algorithm_keep_unidentified_masses:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
65 -algorithm:keep_unidentified_masses
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
66 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
67 #if $adv_opts.adv_opts_selector=='advanced':
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
68 #if $adv_opts.param_force:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
69 -force
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
70 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
71 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
72 </command>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
73 <inputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
74 <param name="param_in" type="data" format="featurexml,consensusxml" optional="False" label="featureXML or consensusXML file" help="(-in) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
75 <param name="param_positive_adducts_file" type="data" format="tabular" optional="False" value="CHEMISTRY/PositiveAdducts.tsv" label="This file contains the list of potential positive adducts that will be looked for in the database" help="(-positive_adducts_file) Edit the list if you wish to exclude/include adducts. By default CHEMISTRY/PositiveAdducts.tsv in OpenMS/share is used! If empty, the default will be used"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
76 <param name="param_negative_adducts_file" type="data" format="tabular" optional="False" value="CHEMISTRY/NegativeAdducts.tsv" label="This file contains the list of potential negative adducts that will be looked for in the database" help="(-negative_adducts_file) Edit the list if you wish to exclude/include adducts. By default CHEMISTRY/NegativeAdducts.tsv in OpenMS/share is used! If empty, the default will be used"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
77 <param name="param_db_mapping" type="data" format="tabular" optional="False" value="CHEMISTRY/HMDBMappingFile.tsv" label="Database input file, containing three tab-separated columns of mass, formula, identifie" help="(-mapping) If 'mass' is 0, it is re-computed from the molecular sum formula. By default CHEMISTRY/HMDBMappingFile.tsv in OpenMS/share is used! If empty, the default will be used"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
78 <param name="param_db_struct" type="data" format="tabular" optional="False" value="CHEMISTRY/HMDB2StructMapping.tsv" label="Database input file, containing four tab-separated columns of identifier, name, SMILES, INCHI.The identifier should match with mapping file" help="(-struct) SMILES and INCHI are reported in the output, but not used otherwise. By default CHEMISTRY/HMDB2StructMapping.tsv in OpenMS/share is used! If empty, the default will be used"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
79 <param name="param_algorithm_mass_error_value" type="float" value="5.0" label="Tolerance allowed for accurate mass search" help="(-mass_error_value) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
80 <param name="param_algorithm_mass_error_unit" type="select" optional="True" value="ppm" label="Unit of mass error (ppm or Da)" help="(-mass_error_unit) ">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
81 <option value="ppm">ppm</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
82 <option value="Da">Da</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
83 </param>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
84 <param name="param_algorithm_ionization_mode" type="select" optional="True" value="positive" label="Positive or negative ionization mode?" help="(-ionization_mode) If 'auto' is used, the first feature of the input map must contain the meta-value 'scan_polarity'. If its missing, the tool will exit with error">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
85 <option value="positive">positive</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
86 <option value="negative">negative</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
87 <option value="auto">auto</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
88 </param>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
89 <param name="param_algorithm_isotopic_similarity" type="boolean" truevalue="-algorithm:isotopic_similarity" falsevalue="" checked="false" optional="True" label="Computes a similarity score for each hit (only if the feature exhibits at least two isotopic mass traces)" help="(-isotopic_similarity) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
90 <param name="param_algorithm_report_mode" type="select" optional="True" value="all" label="Results are reported in one of several modes: Either (all) matching hits, the (top3) scoring hits, or the (best) scoring hit" help="(-report_mode) ">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
91 <option value="all">all</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
92 <option value="top3">top3</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
93 <option value="best">best</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
94 </param>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
95 <param name="param_algorithm_keep_unidentified_masses" type="boolean" truevalue="-algorithm:keep_unidentified_masses" falsevalue="" checked="false" optional="True" label="Keep features that did not yield any DB hit" help="(-keep_unidentified_masses) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
96 <expand macro="advanced_options">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
97 <param name="param_force" type="boolean" truevalue="-force" falsevalue="" checked="false" optional="True" label="Overwrite tool specific checks" help="(-force) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
98 </expand>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
99 </inputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
100 <outputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
101 <data name="param_out" format="tabular"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
102 <data name="param_out_annotation" metadata_source="param_in" format="input"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
103 </outputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
104 <help>**What it does**
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
105
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
106 Find potential HMDB ids within the given mass error window.
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
107
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
108
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
109 For more information, visit http://ftp.mi.fu-berlin.de/OpenMS/release-documentation/html/UTILS_AccurateMassSearch.html</help>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
110 <expand macro="references"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
111 </tool>