annotate Decharger.xml @ 4:60a33af52042 draft default tip

Uploaded
author galaxyp
date Wed, 13 May 2015 21:19:44 -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="Decharger" name="Decharger" version="2.0.0">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
3 <description>Decharges and merges different feature charge variants of the same peptide.</description>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
4 <macros>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
5 <token name="@EXECUTABLE@">Decharger</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>Decharger
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_cm:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
16 -out_cm $param_out_cm
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
17 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
18 #if $param_out_fm:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
19 -out_fm $param_out_fm
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
20 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
21 #if $param_outpairs:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
22 -outpairs $param_outpairs
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
23 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
24 -threads \${GALAXY_SLOTS:-24}
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
25 #if $param_algorithm_FeatureDeconvolution_charge_min:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
26 -algorithm:FeatureDeconvolution:charge_min $param_algorithm_FeatureDeconvolution_charge_min
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
27 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
28 #if $param_algorithm_FeatureDeconvolution_charge_max:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
29 -algorithm:FeatureDeconvolution:charge_max $param_algorithm_FeatureDeconvolution_charge_max
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
30 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
31 #if $param_algorithm_FeatureDeconvolution_charge_span_max:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
32 -algorithm:FeatureDeconvolution:charge_span_max $param_algorithm_FeatureDeconvolution_charge_span_max
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
33 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
34 #if $param_algorithm_FeatureDeconvolution_q_try:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
35 -algorithm:FeatureDeconvolution:q_try
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
36 #if " " in str($param_algorithm_FeatureDeconvolution_q_try):
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
37 "$param_algorithm_FeatureDeconvolution_q_try"
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
38 #else
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
39 $param_algorithm_FeatureDeconvolution_q_try
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
40 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
41 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
42 #if $param_algorithm_FeatureDeconvolution_retention_max_diff:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
43 -algorithm:FeatureDeconvolution:retention_max_diff $param_algorithm_FeatureDeconvolution_retention_max_diff
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
44 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
45 #if $param_algorithm_FeatureDeconvolution_retention_max_diff_local:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
46 -algorithm:FeatureDeconvolution:retention_max_diff_local $param_algorithm_FeatureDeconvolution_retention_max_diff_local
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
47 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
48 #if $param_algorithm_FeatureDeconvolution_mass_max_diff:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
49 -algorithm:FeatureDeconvolution:mass_max_diff $param_algorithm_FeatureDeconvolution_mass_max_diff
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
50 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
51
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
52 #if $rep_param_algorithm_FeatureDeconvolution_potential_adducts:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
53 -algorithm:FeatureDeconvolution:potential_adducts
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
54 #for token in $rep_param_algorithm_FeatureDeconvolution_potential_adducts:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
55 #if " " in str(token):
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
56 "$token.param_algorithm_FeatureDeconvolution_potential_adducts"
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
57 #else
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
58 $token.param_algorithm_FeatureDeconvolution_potential_adducts
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
59 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
60 #end for
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
61 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
62 #if $param_algorithm_FeatureDeconvolution_max_neutrals:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
63 -algorithm:FeatureDeconvolution:max_neutrals $param_algorithm_FeatureDeconvolution_max_neutrals
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
64 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
65 #if $param_algorithm_FeatureDeconvolution_max_minority_bound:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
66 -algorithm:FeatureDeconvolution:max_minority_bound $param_algorithm_FeatureDeconvolution_max_minority_bound
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
67 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
68 #if $param_algorithm_FeatureDeconvolution_min_rt_overlap:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
69 -algorithm:FeatureDeconvolution:min_rt_overlap $param_algorithm_FeatureDeconvolution_min_rt_overlap
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
70 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
71 #if $param_algorithm_FeatureDeconvolution_intensity_filter:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
72 -algorithm:FeatureDeconvolution:intensity_filter
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
73 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
74 #if $adv_opts.adv_opts_selector=='advanced':
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
75 #if $adv_opts.param_force:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
76 -force
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
77 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
78 #if $adv_opts.param_algorithm_FeatureDeconvolution_default_map_label:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
79 -algorithm:FeatureDeconvolution:default_map_label "$adv_opts.param_algorithm_FeatureDeconvolution_default_map_label"
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
80 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
81 #if $adv_opts.param_algorithm_FeatureDeconvolution_verbose_level:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
82 -algorithm:FeatureDeconvolution:verbose_level $adv_opts.param_algorithm_FeatureDeconvolution_verbose_level
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
83 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
84 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
85 </command>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
86 <inputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
87 <param name="param_in" type="data" format="featurexml" optional="False" label="input file" help="(-in) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
88 <param name="param_algorithm_FeatureDeconvolution_charge_min" type="integer" value="1" label="Minimal possible charge" help="(-charge_min) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
89 <param name="param_algorithm_FeatureDeconvolution_charge_max" type="integer" value="10" label="Maximal possible charge" help="(-charge_max) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
90 <param name="param_algorithm_FeatureDeconvolution_charge_span_max" type="integer" min="1" optional="True" value="4" label="Maximal range of charges for a single analyte, i.e" help="(-charge_span_max) observing q1=[5,6,7] implies span=3. Setting this to 1 will only find adduct variants of the same charge"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
91 <param name="param_algorithm_FeatureDeconvolution_q_try" type="select" optional="True" value="feature" label="Try different values of charge for each feature according to the above settings ('heuristic' [does not test all charges, just the likely ones] or 'all' ), or leave feature charge untouched ('feature')" help="(-q_try) ">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
92 <option value="feature">feature</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
93 <option value="heuristic">heuristic</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
94 <option value="all">all</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
95 </param>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
96 <param name="param_algorithm_FeatureDeconvolution_retention_max_diff" type="float" value="1.0" label="Maximum allowed RT difference between any two features if their relation shall be determined" help="(-retention_max_diff) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
97 <param name="param_algorithm_FeatureDeconvolution_retention_max_diff_local" type="float" value="1.0" label="Maximum allowed RT difference between between two co-features, after adduct shifts have been accounted for (if you do not have any adduct shifts, this value should be equal to 'retention_max_diff', otherwise it should be smaller!)" help="(-retention_max_diff_local) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
98 <param name="param_algorithm_FeatureDeconvolution_mass_max_diff" type="float" value="0.5" label="Maximum allowed mass difference [in Th] for a single feature" help="(-mass_max_diff) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
99 <repeat name="rep_param_algorithm_FeatureDeconvolution_potential_adducts" min="0" max="1" title="param_algorithm_FeatureDeconvolution_potential_adducts">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
100 <param name="param_algorithm_FeatureDeconvolution_potential_adducts" type="text" size="30" value="H+:0.9" label="Adducts used to explain mass differences in format: 'Element(+)*:Probability[:RTShift[:Label]]', i.e. the number of '+' indicate the charge," help="(-potential_adducts) e.g. 'Ca++:0.5' indicates +2. Probabilites have to be in (0,1]. RTShift param is optional and indicates the expected RT shift caused by this adduct, e.g. '(2)H4H-4:1:-3' indicates a 4 deuterium label, which causes early elution by 3 seconds. As a fourth parameter you can add a label which is tagged on every feature which has this adduct. This also determines the map number in the consensus file">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
101 <sanitizer>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
102 <valid initial="string.printable">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
103 <remove value="'"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
104 <remove value="&quot;"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
105 </valid>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
106 </sanitizer>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
107 </param>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
108 </repeat>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
109 <param name="param_algorithm_FeatureDeconvolution_max_neutrals" type="integer" value="0" label="Maximal number of neutral adducts(q=0) allowed" help="(-max_neutrals) Add them in the 'potential_adducts' section!"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
110 <param name="param_algorithm_FeatureDeconvolution_max_minority_bound" type="integer" min="0" optional="True" value="2" label="Maximum count of the least probable adduct (according to 'potential_adducts' param) within a charge variant" help="(-max_minority_bound) E.g. setting this to 2 will not allow an adduct composition of '1(H+),3(Na+)' if Na+ is the least probable adduct"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
111 <param name="param_algorithm_FeatureDeconvolution_min_rt_overlap" type="float" min="0.0" max="1.0" optional="True" value="0.66" label="Minimum overlap of the convex hull' RT intersection measured against the union from two features (if CHs are given)" help="(-min_rt_overlap) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
112 <param name="param_algorithm_FeatureDeconvolution_intensity_filter" type="boolean" truevalue="-algorithm:FeatureDeconvolution:intensity_filter" falsevalue="" checked="false" optional="True" label="Enable the intensity filter, which will only allow edges between two equally charged features if the intensity of the feature with less likely adducts is smaller than that of the other feature" help="(-intensity_filter) It is not used for features of different charge"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
113 <expand macro="advanced_options">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
114 <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
115 <param name="param_algorithm_FeatureDeconvolution_default_map_label" type="text" size="30" value="decharged features" label="Label of map in output consensus file where all features are put by default" help="(-default_map_label) ">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
116 <sanitizer>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
117 <valid initial="string.printable">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
118 <remove value="'"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
119 <remove value="&quot;"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
120 </valid>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
121 </sanitizer>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
122 </param>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
123 <param name="param_algorithm_FeatureDeconvolution_verbose_level" type="integer" min="0" max="3" optional="True" value="0" label="Amount of debug information given during processing" help="(-verbose_level) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
124 </expand>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
125 </inputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
126 <outputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
127 <data name="param_out_cm" format="consensusxml"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
128 <data name="param_out_fm" format="featurexml"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
129 <data name="param_outpairs" format="consensusxml"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
130 </outputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
131 <help>**What it does**
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
132
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
133 Decharges and merges different feature charge variants of the same peptide.
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
134
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
135
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
136 For more information, visit http://ftp.mi.fu-berlin.de/OpenMS/release-documentation/html/TOPP_Decharger.html</help>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
137 <expand macro="references"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
138 </tool>