annotate IDMapper.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="IDMapper" name="IDMapper" version="1.12.0">
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
3 <description>Assigns protein/peptide identifications to features or consensus features.</description>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
4 <macros>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
5 <token name="@EXECUTABLE@">IDMapper</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>IDMapper
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
11
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
12 -id ${param_id}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
13 -in ${param_in}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
14 -out ${param_out}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
15 -rt_tolerance ${param_rt_tolerance}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
16 -mz_tolerance ${param_mz_tolerance}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
17 -mz_measure ${param_mz_measure}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
18 -mz_reference ${param_mz_reference}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
19 ${param_ignore_charge}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
20 -threads \${GALAXY_SLOTS:-24}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
21 ${param_use_centroid_rt}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
22 ${param_use_centroid_mz}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
23 ${param_use_subelements}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
24 </command>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
25 <inputs>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
26 <param name="param_id" type="data" format="idXML" optional="False" label="Protein/peptide identifications file" help="(-id)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
27 <param name="param_in" type="data" format="featureXML,consensusXML" optional="False" label="Feature map/consensus map file" help="(-in)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
28 <param name="param_rt_tolerance" type="float" min="0.0" optional="True" value="5.0" label="RT tolerance (in seconds) for the matching of peptide identifications and (consensus) features.#br#Tolerance is understood as 'plus or minus x', so the matching range increases by twice the given value." help="(-rt_tolerance)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
29 <param name="param_mz_tolerance" type="float" min="0.0" optional="True" value="20.0" label="m/z tolerance (in ppm or Da) for the matching of peptide identifications and (consensus) features.#br#Tolerance is understood as 'plus or minus x', so the matching range increases by twice the given value." help="(-mz_tolerance)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
30 <param name="param_mz_measure" type="select" optional="True" value="ppm" label="Unit of 'mz_tolerance'." help="(-mz_measure)">
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
31 <option value="ppm">ppm</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
32 <option value="Da">Da</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
33 </param>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
34 <param name="param_mz_reference" type="select" optional="True" value="precursor" label="Source of m/z values for peptide identifications. If 'precursor', the precursor-m/z from the idXML is used. If 'peptide',#br#masses are computed from the sequences of peptide hits; in this case, an identification matches if any of its hits matches.#br#('peptide' should be used together with 'feature:use_centroid_mz' to avoid false-positive matches.)" help="(-mz_reference)">
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
35 <option value="precursor">precursor</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
36 <option value="peptide">peptide</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
37 </param>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
38 <param name="param_ignore_charge" type="boolean" truevalue="-ignore_charge true" falsevalue="-ignore_charge false" checked="false" optional="True" label="For feature/consensus maps: Assign an ID independently of whether its charge state matches that of the (consensus) feature." help="(-ignore_charge)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
39 <param name="param_use_centroid_rt" type="boolean" truevalue="-feature:use_centroid_rt true" falsevalue="-feature:use_centroid_rt false" checked="false" optional="True" label="Use the RT coordinates of the feature centroids for matching, instead of the RT ranges of the features/mass traces." help="(-use_centroid_rt)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
40 <param name="param_use_centroid_mz" type="boolean" truevalue="-feature:use_centroid_mz true" falsevalue="-feature:use_centroid_mz false" checked="false" optional="True" label="Use the m/z coordinates of the feature centroids for matching, instead of the m/z ranges of the features/mass traces.#br#(If you choose 'peptide' as 'mz_reference', you should usually set this flag to avoid false-positive matches.)" help="(-use_centroid_mz)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
41 <param name="param_use_subelements" type="boolean" truevalue="-consensus:use_subelements true" falsevalue="-consensus:use_subelements false" checked="false" optional="True" label="Match using RT and m/z of sub-features instead of consensus RT and m/z. A consensus feature matches if any of its sub-features matches." help="(-use_subelements)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
42 </inputs>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
43 <outputs>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
44 <data name="param_out" label="Output file (the format depends on the input file format)." format="consensusXML">
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
45 <change_format>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
46 <when input="param_out_type" value="featureXML" format="featureXML"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
47 </change_format>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
48 </data>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
49 </outputs>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
50 <help>**What it does**
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
51
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
52 Assigns protein/peptide identifications to features or consensus features.
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
53
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
54
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
55 For more information, visit http://ftp.mi.fu-berlin.de/OpenMS/release-documentation/html/TOPP_IDMapper.html
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
56
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
57 @REFERENCES@
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
58 </help>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
59 </tool>