annotate feature_finder_centroided.xml @ 3:8fa16707e162 draft

Update.
author galaxyp
date Fri, 10 May 2013 17:31:59 -0400
parents cf0d72c7b482
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
1 <tool id="openms_feature_finder_centroided" version="0.1.0" name="Feature Finder (Centroided)">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
2 <description>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
3 The feature detection application for quantitation (centroided).
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
4 </description>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
5 <macros>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
6 <import>macros.xml</import>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
7 </macros>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
8 <expand macro="stdio" />
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
9 <expand macro="requires" />
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
10 <command interpreter="python">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
11 openms_wrapper.py --executable 'FeatureFinderCentroided' --config $config
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
12 </command>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
13 <configfiles>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
14 <configfile name="config">[simple_options]
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
15 in=$input1
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
16 out=$output
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
17 algorithm!intensity!bins=$bins
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
18 algorithm!mass_trace!mz_tolerance=$trace_mz_tolerance
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
19 algorithm!mass_trace!min_spectra=$min_spectra
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
20 algorithm!mass_trace!max_missing=$max_missing
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
21 algorithm!seed!min_score=$seed_min_score
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
22 algorithm!feature!min_score=$feature_min_score
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
23 algorithm!feature!reported_mz=$reported_mz
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
24 algorithm!isotopic_pattern!mz_tolerance=$isotopic_mz_tolerance
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
25 algorithm!isotopic_pattern!charge_low=$charge_low
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
26 algorithm!isotopic_pattern!charge_high=$charge_high
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
27 #if $advanced_isotopic_pattern.specify
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
28 algorithm!isotopic_pattern!abundance_12C=$abundance_12C
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
29 algorithm!isotopic_pattern!abundance_14N=$abundance_14N
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
30 #end if
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
31 </configfile>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
32 </configfiles>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
33 <inputs>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
34 <param name="input1" label="mzML Input" type="data" format="mzml" />
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
35 <param name="bins" label="Bins" type="integer" help="Number of bins per dimension (RT and m/z). The higher this value, the more local the intensity significance score is. This parameter should be decreased, if the algorithm is used on small regions of a map." value="10" />
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
36 <param name="trace_mz_tolerance" type="float" label="m/z Tolerance (Trace)" help="Tolerated m/z deviation of peaks belonging to the same mass trace. It should be larger than the m/z resolution of the instument. This value must be smaller than that 1/charge_high!" value="0.03" />
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
37 <param name="min_spectra" label="Minimum Number of Spectra" help="Number of spectra that have to show a similar peak mass in a mass trace." value="10" type="integer" />
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
38 <param name="max_missing" label="Max Missing" help="Number of consecutive spectra where a high mass deviation or missing peak is acceptable. This parameter should be well below 'min_spectra'!" value="1" type="integer" />
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
39 <param name="seed_min_score" label="Seed Minimum Score" help="Minimum seed score a peak has to reach to be used as seed. The seed score is the geometric mean of intensity score, mass trace score and isotope pattern score. If your features show a large deviation from the averagene isotope distribution or from an gaussian elution profile, lower this score." type="float" value="0.8" />
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
40 <param name="feature_min_score" label="Feature Minimum Score" help="Feature score threshold for a feature to be reported. The feature score is the geometric mean of the average relative deviation and the correlation between the model and the observed peaks." value="0.7" type="float" />
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
41 <param name="reported_mz" label="Reported m/z" help="The mass type that is reported for features. 'maximum' returns the m/z value of the highest mass trace. 'average' returns the intensity-weighted average m/z value of all contained peaks. 'monoisotopic' returns the monoisotopic m/z value derived from the fitted isotope model." type="select">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
42 <option value="monoisotopic">monoisotopic</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
43 <option value="average">average</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
44 <option value="maximum">maximum</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
45 </param>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
46 <param name="charge_low" label="Minimum Charge" type="integer" value="1" />
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
47 <param name="charge_high" label="Maximum Charge" type="integer" value="4" />
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
48 <param name="isotopic_mz_tolerance" label="m/z Tolerance (Isotopic Pattern)" type="float" value="0.03" help="Tolerated m/z deviation from the theoretical isotopic pattern. It should be larger than the m/z resolution of the instument. This value must be smaller than that 1/charge_high!" />
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
49 <conditional name="advanced_isotopic_pattern">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
50 <param type="boolean" name="specify" label="Specify Advanced Isotopic Pattern Parameters" />
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
51 <when value="true">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
52 <param name="abundance_12C" label="12C Abundance" type="float" value="98.93" help="Rel. abundance of the light carbon. Modify if labeled." />
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
53 <param name="abundance_14N" label="14N Abundance" type="float" value="99.632" help="Rel. abundance of the light nitrogen. Modify if labeled." />
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
54 </when>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
55 <when value="false">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
56 </when>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
57 </conditional>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
58 </inputs>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
59 <outputs>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
60 <data format="featurexml" name="output" />
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
61 </outputs>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
62 <help>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
63 **What it does**
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
64
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
65 The mapping is based on retention times and mass-to-charge values. Roughly, a peptide identification is assigned to a (consensus) feature if its position lies within the boundaries of the feature or close enough to the feature centroid. Peptide identifications that don't match anywhere are still recorded in the resulting map, as "unassigned peptides". Protein identifications are annotated to the whole map, i.e. not to any particular (consensus) feature.
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
66
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
67 In all cases, tolerance in RT and m/z dimension is applied according to the parameters rt_tolerance and mz_tolerance. Tolerance is understood as "plus or minus x", so the matching range is actually increased by twice the tolerance value.
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
68
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
69 If several features or consensus features overlap the position of a peptide identification (taking the allowed tolerances into account), the identification is annotated to all of them.
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
70
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
71 Annotation of feature maps (featureXML input):
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
72 If all features have at least one convex hull, peptide positions are matched against the bounding boxes of the convex hulls (of individual mass traces, if available) by default. If not, the positions of the feature centroids are used. The respective coordinates of the centroids are also used for matching (in place of the corresponding ranges from the bounding boxes) if feature:use_centroid_rt or feature:use_centroid_mz are true.
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
73
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
74 Annotation of consensus maps (consensusXML input):
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
75 Peptide positions are always matched against centroid positions. By default, the consensus centroids are used. However, if consensusfeature:use_subelements is set, the centroids of sub-features are considered instead. In this case, a peptide identification is mapped to a consensus feature if any of its sub-features matches.
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
76
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
77 **Citation**
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
78
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
79 For the underlying tool, please cite ``Marc Sturm, Andreas Bertsch, Clemens Gröpl, Andreas Hildebrandt, Rene Hussong, Eva Lange, Nico Pfeifer, Ole Schulz-Trieglaff, Alexandra Zerck, Knut Reinert, and Oliver Kohlbacher, 2008. OpenMS – an Open-Source Software Framework for Mass Spectrometry. BMC Bioinformatics 9: 163. doi:10.1186/1471-2105-9-163.``
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
80
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
81 If you use this tool in Galaxy, please cite Chilton J, et al. https://bitbucket.org/galaxyp/galaxyp-toolshed-openms
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
82 </help>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
83 </tool>