annotate extract_background_ions.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_extract_background_ions" version="0.1.0" name="Extract Background Ions">
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
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
11 --executable '__SHELL__' --config $setup
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
12 --executable 'ExtractBackgroundIons' --config $config
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
13 </command>
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
14 <configfiles>
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
15 <configfile name="setup">ln -s $input1 input.${input1.ext}</configfile>
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
16 <configfile name="config">-ppm $ppm -i input.${input1.ext} -o $output -threshold $threshold</configfile>
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
17 </configfiles>
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
18 <inputs>
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
19 <param name="input1" label="Input" type="data" format="mzml,mzxml" />
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
20 <param name="ppm" label="ppm" value="3" type="float" help="The accuracy of the measurement in parts-per-milion. This value is used for the collection of the data-points belonging to a background ion and needs to be reasonable for the equipment used to make the measurement (the LTQ-Orbitrap manages approximatetly 3 ppm)." />
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
21 <param name="threshold" type="float" value="0.02" label="Treshold" help="The percentage (a value between 0 and 1) of scans that minimally need to contain a measurement." />
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
22 </inputs>
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
23 <outputs>
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
24 <data format="peakml" name="output" />
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
25 </outputs>
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
26 <help>
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
27 **What it does**
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
28
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
29 Extracts background ions (x-axis: RT; y-axis: Intensity) from 2D mass spectrometry data (LC/MS or GC/MS). The raw data is loaded from the open standard file formats (mzML, mzXML or mzData) and all of the individidual mass traces (M/Z +/- ppm over the whole scan range) are retrieved. A mass trace is retained when it is present in more than the given percentage of scans (option 'threshold').
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
30
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
31 The resulting output file is in PeakML-format, containing a list of all the extracted background ions.
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
32
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
33 **Citation**
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
34
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
35 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
36
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
37 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
38 </help>
201a15633354 Initial commit.
galaxyp
parents:
diff changeset
39 </tool>