annotate noise_filter.xml @ 0:201a15633354 draft default tip

Initial commit.
author galaxyp
date Fri, 10 May 2013 17:28:02 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
1 <tool id="mzmatch_noise_filter" version="0.1.0" name="Noise Filter">
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
2 <description>
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
3 </description>
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
4 <macros>
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
5 <import>macros.xml</import>
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
6 </macros>
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
7 <expand macro="stdio" />
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
8 <expand macro="requires" />
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
9 <command interpreter="python">
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
10 mzmatch_wrapper.py --executable 'filter.NoiseFilter' --config $config
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
11 </command>
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
12 <configfiles>
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
13 <configfile name="config">-i $input1 -o $output -rejected $output_rejected #if $codadw.specify # -codadw $codadw.codadw #end if#</configfile>
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
14 </configfiles>
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
15 <inputs>
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
16 <param name="input1" label="Input" type="data" format="peakml" />
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
17 <conditional name="codadw">
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
18 <param name="specify" label="Specify CoDA-DW Filter" type="boolean" />
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
19 <when value="true">
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
20 <param name="codadw" type="float" label="CoDA-DW Threshold" value="0.8" />
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
21 </when>
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
22 <when value="false">
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
23 </when>
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
24 </conditional>
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
25 </inputs>
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
26 <outputs>
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
27 <data format="peakml" name="output" label="Noise Filtered ${on_string}" />
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
28 <data format="peakml" name="output_rejected" label="Noise Filtered Rejected ${on_string}" />
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
29 </outputs>
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
30 <help>
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
31 **What it does**
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
32
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
33 Filters noise from PeakML files, containing mass chromatograms at the lowest level. When the file contains a list of sets of mass chromatograms, the maximum score for the used method is calculated and compared to the given threshold. This is the best approach, as we expect that high quality can match up to low quality signals at the same mass and retention time. Only those entries scoring above the given threshold are stored in the output file. The rejected can be stored in a separate file (option 'rejected') for inspection or recovery.
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
34
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
35 The option 'codadw' can be used to set the threshold for the CoDA Durbin-Watson noise filtering approach. Normally the Durbin-Watson criterion results in a value between 0 and 4, where higher means a large amount of periodicity in the signal and lower vica versa. For mass chromatograms we expect little periodicity in the signal, thus a lower value is preferable. However, in order to preserve unity in our quality scores the CoDA-DW score is scaled between 0..1, where higher is better (less periodicity in the signal). As a general rule-of-thumb, for high quality mass chromatograms a score >0.8 is expected.
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
36
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
37 Remarks:
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
38 - CoDA-DW is scaled between 0..1, where higher is better mass chromatogram quality.
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
39
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
40 **Citation**
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
41
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
42 For the underlying tool, please cite ``PeakML/mzMatch: A File Format, Java Library, R Library, and Tool-Chain for Mass Spectrometry Data Analysis. Richard A. Scheltema, Andris Jankevics, Ritsert C. Jansen, Morris A. Swertz, and Rainer Breitling. Analytical Chemistry 2011 83 (7), pp 2786-2793``
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
43
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
44 If you use this tool in Galaxy, please cite Chilton J, et al. https://bitbucket.org/galaxyp/galaxyp-toolshed-mzmatch
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
45 </help>
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
46 </tool>