annotate Decharger.xml @ 0:3d84209d3178 draft

Uploaded
author bgruening
date Fri, 10 Oct 2014 18:20:03 -0400
parents
children 6ead64a594bd
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
1 <?xml version='1.0' encoding='UTF-8'?>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
2 <tool id="Decharger" name="Decharger" version="1.12.0">
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
3 <description>Decharges and merges different feature charge variants of the same peptide.</description>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
4 <macros>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
5 <token name="@EXECUTABLE@">Decharger</token>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
6 <import>macros.xml</import>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
7 </macros>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
8 <expand macro="stdio"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
9 <expand macro="requirements"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
10 <command>Decharger
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
11
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
12 -in ${param_in}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
13 -out_cm ${param_out_cm}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
14 -out_fm ${param_out_fm}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
15 -outpairs ${param_outpairs}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
16 -threads \${GALAXY_SLOTS:-24}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
17 -algorithm:FeatureDeconvolution:charge_min ${param_charge_min}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
18 -algorithm:FeatureDeconvolution:charge_max ${param_charge_max}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
19 -algorithm:FeatureDeconvolution:charge_span_max ${param_charge_span_max}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
20 -algorithm:FeatureDeconvolution:q_try ${param_q_try}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
21 -algorithm:FeatureDeconvolution:retention_max_diff ${param_retention_max_diff}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
22 -algorithm:FeatureDeconvolution:retention_max_diff_local ${param_retention_max_diff_local}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
23 -algorithm:FeatureDeconvolution:mass_max_diff ${param_mass_max_diff}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
24 -algorithm:FeatureDeconvolution:potential_adducts ${param_potential_adducts}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
25 -algorithm:FeatureDeconvolution:max_neutrals ${param_max_neutrals}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
26 -algorithm:FeatureDeconvolution:max_minority_bound ${param_max_minority_bound}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
27 -algorithm:FeatureDeconvolution:min_rt_overlap ${param_min_rt_overlap}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
28 ${param_intensity_filter}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
29 #if $adv_opts.adv_opts_selector=='advanced':
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
30 -algorithm:FeatureDeconvolution:default_map_label ${adv_opts.param_default_map_label}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
31 -algorithm:FeatureDeconvolution:verbose_level ${adv_opts.param_verbose_level}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
32 #end if
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
33 </command>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
34 <inputs>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
35 <param name="param_in" type="data" format="featureXML" optional="False" label="input file " help="(-in)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
36 <param name="param_charge_min" type="integer" value="1" label="Minimal possible charge" help="(-charge_min)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
37 <param name="param_charge_max" type="integer" value="10" label="Maximal possible charge" help="(-charge_max)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
38 <param name="param_charge_span_max" type="integer" min="1" optional="True" value="4" label="Maximal range of charges for a single analyte, i.e. observing q1=[5,6,7] implies span=3. Setting this to 1 will only find adduct variants of the same charge" help="(-charge_span_max)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
39 <param name="param_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)">
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
40 <option value="feature">feature</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
41 <option value="heuristic">heuristic</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
42 <option value="all">all</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
43 </param>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
44 <param name="param_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)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
45 <param name="param_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)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
46 <param name="param_mass_max_diff" type="float" value="0.5" label="Maximum allowed mass difference [in Th] for a single feature." help="(-mass_max_diff)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
47 <param name="param_potential_adducts" type="text" size="20" 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, 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." help="(-potential_adducts)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
48 <param name="param_max_neutrals" type="integer" value="0" label="Maximal number of neutral adducts(q=0) allowed. Add them in the 'potential_adducts' section!" help="(-max_neutrals)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
49 <param name="param_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. E.g. setting this to 2 will not allow an adduct composition of '1(H+),3(Na+)' if Na+ is the least probable adduct" help="(-max_minority_bound)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
50 <param name="param_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)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
51 <param name="param_intensity_filter" type="boolean" truevalue="-algorithm:FeatureDeconvolution:intensity_filter true" falsevalue="-algorithm:FeatureDeconvolution:intensity_filter false" 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. It is not used for features of different charge." help="(-intensity_filter)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
52 <expand macro="advanced_options">
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
53 <param name="param_default_map_label" type="text" size="20" value="decharged features" label="Label of map in output consensus file where all features are put by default" help="(-default_map_label)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
54 <param name="param_verbose_level" type="integer" min="0" max="3" optional="True" value="0" label="Amount of debug information given during processing." help="(-verbose_level)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
55 </expand>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
56 </inputs>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
57 <outputs>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
58 <data name="param_out_cm" label="output consensus map" format="consensusXML"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
59 <data name="param_out_fm" label="output feature map" format="featureXML"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
60 <data name="param_outpairs" label="output file" format="consensusXML"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
61 </outputs>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
62 <help>**What it does**
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
63
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
64 Decharges and merges different feature charge variants of the same peptide.
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
65
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
66
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
67 For more information, visit http://ftp.mi.fu-berlin.de/OpenMS/release-documentation/html/TOPP_Decharger.html
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
68
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
69 @REFERENCES@
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
70 </help>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
71 </tool>