annotate masscomb_dbsearch_converter.xml @ 12:e38e97bc902d

added comment
author pieter.lukasse@wur.nl
date Fri, 23 Jan 2015 15:45:50 +0100
parents 1a6fa343b981
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
11
1a6fa343b981 Adding auto install for proteowizard dependency
pieter.lukasse@wur.nl
parents: 9
diff changeset
1 <tool name="DB search converter" id="masscomb_dbsearch_converter" version="1.0.5">
0
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
2 <description> Convert search results to MzIdentML (aka mzid) format</description>
11
1a6fa343b981 Adding auto install for proteowizard dependency
pieter.lukasse@wur.nl
parents: 9
diff changeset
3 <requirements>
1a6fa343b981 Adding auto install for proteowizard dependency
pieter.lukasse@wur.nl
parents: 9
diff changeset
4 <requirement type="set_environment">PWIZ_3_0_5622_PATH</requirement>
1a6fa343b981 Adding auto install for proteowizard dependency
pieter.lukasse@wur.nl
parents: 9
diff changeset
5 <requirement type="package" version="3.05622">proteowizard</requirement>
1a6fa343b981 Adding auto install for proteowizard dependency
pieter.lukasse@wur.nl
parents: 9
diff changeset
6 </requirements>
0
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
7 <!--
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
8 For remote debugging start you listener on port 8000 and use the following as command interpreter:
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
9 java -jar -Xdebug -Xrunjdwp:transport=dt_socket,address=D0100564.wurnet.nl:8000
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
10 //////////////////////////
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
11 -->
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
12 <command interpreter="java -jar">
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
13 MassComb.jar
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
14 -action DBSEARCHCONVERT
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
15 -fileGrouping $fileType.type
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
16 -searchResultsFormat $fileType.inputFormatType.inputFormat
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
17 #if $fileType.inputFormatType.inputFormat == "xtandem"
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
18 -isMs2SpectrumIdStartingAtZero $fileType.inputFormatType.isMs2SpectrumIdStartingAtZero
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
19 #end if
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
20 -inputFile $fileType.inputFormatType.inputFile
9
c317e0f939df Made converter more robust and added support for mzXML in xtandem interface
pieter.lukasse@wur.nl
parents: 0
diff changeset
21 -outputMsMsFragmentationData $outputMsMsFragmentationData
0
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
22 -outputFile $outputFile
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
23 </command>
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
24 <inputs>
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
25 <conditional name="fileType">
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
26 <param name="type" type="select" label="select file grouping type">
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
27 <option value="single" selected="true">single-File</option>
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
28 <option value="fileSet">fileSet</option>
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
29 </param>
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
30 <when value="single">
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
31 <conditional name="inputFormatType">
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
32 <param name="inputFormat" type="select" label="inputFormat">
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
33 <option value="xtandem">X!Tandem</option>
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
34 <option value="omssa">OMSSA</option>
9
c317e0f939df Made converter more robust and added support for mzXML in xtandem interface
pieter.lukasse@wur.nl
parents: 0
diff changeset
35 <option value="proteomediscoverer_pepxml">Proteome Discoverer (pepxml) [beta]</option>
0
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
36 </param>
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
37 <when value="xtandem">
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
38 <param name="inputFile" type="data" format="bioml,xml" label="MS/MS search results" help="Note: the spectra index values in the resulting file will only be reliable for when X!Tandem has executed on MzML data"/>
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
39 <param name="isMs2SpectrumIdStartingAtZero" type="select" label="Spectrum numbering starting at zero in original spectra file" help="Some formats, like mzML, start their spectrum numbering from 0, other formats start from 1. ">
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
40 <option value="true" selected="true">Yes, starting at 0</option>
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
41 <option value="false">No, starting at 1</option>
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
42 </param>
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
43 </when>
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
44 <when value="omssa">
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
45 <param name="inputFile" type="data" format="omx" label="MS/MS search results"/>
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
46 </when>
9
c317e0f939df Made converter more robust and added support for mzXML in xtandem interface
pieter.lukasse@wur.nl
parents: 0
diff changeset
47 <when value="proteomediscoverer_pepxml">
12
e38e97bc902d added comment
pieter.lukasse@wur.nl
parents: 11
diff changeset
48 <param name="inputFile" type="data" format="any" label="MS/MS search results (pepxml)"/>
9
c317e0f939df Made converter more robust and added support for mzXML in xtandem interface
pieter.lukasse@wur.nl
parents: 0
diff changeset
49 </when>
0
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
50 </conditional>
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
51 </when>
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
52 <when value="fileSet">
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
53 <conditional name="inputFormatType">
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
54 <param name="inputFormat" type="select" label="inputFormat">
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
55 <option value="xtandem">X!Tandem</option>
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
56 <option value="omssa">OMSSA</option>
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
57 </param>
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
58 <when value="xtandem">
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
59 <param name="inputFile" type="data" format="prims.fileset.zip" label="MS/MS search results" />
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
60 <param name="isMs2SpectrumIdStartingAtZero" type="select" label="Spectrum numbering starting at zero in original spectra file" help="Some formats, like mzML, start their spectrum numbering from 0, other formats start from 1. ">
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
61 <option value="true" selected="true">Yes, starting at 0</option>
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
62 <option value="false">No, starting at 1</option>
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
63 </param>
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
64 </when>
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
65 <when value="omssa">
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
66 <param name="inputFile" type="data" format="prims.fileset.zip" label="MS/MS search results"/>
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
67 </when>
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
68 </conditional>
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
69 </when>
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
70 </conditional>
9
c317e0f939df Made converter more robust and added support for mzXML in xtandem interface
pieter.lukasse@wur.nl
parents: 0
diff changeset
71 <param name="outputMsMsFragmentationData" type="boolean" checked="false"
c317e0f939df Made converter more robust and added support for mzXML in xtandem interface
pieter.lukasse@wur.nl
parents: 0
diff changeset
72 label="Output MS/MS fragmentation data"
12
e38e97bc902d added comment
pieter.lukasse@wur.nl
parents: 11
diff changeset
73 help="NB: this will add to the output also the fragment ions related to each peptide identification.
e38e97bc902d added comment
pieter.lukasse@wur.nl
parents: 11
diff changeset
74 NB2: Fragment ion annotation data is
e38e97bc902d added comment
pieter.lukasse@wur.nl
parents: 11
diff changeset
75 inferred based on new calculations triggered by this conversion tool.
e38e97bc902d added comment
pieter.lukasse@wur.nl
parents: 11
diff changeset
76 This is done because fragment ion annotation information is not present
e38e97bc902d added comment
pieter.lukasse@wur.nl
parents: 11
diff changeset
77 in X!Tandem file (X!Tandem SLEDGEHAMMER (2013.09.01) and previous)"/>
9
c317e0f939df Made converter more robust and added support for mzXML in xtandem interface
pieter.lukasse@wur.nl
parents: 0
diff changeset
78
0
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
79 </inputs>
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
80 <outputs>
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
81 <data name="outputFile" format="mzid" label="${tool.name} (to MzIdentML) on ${on_string} ">
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
82 <change_format>
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
83 <when input="fileType.type" value="fileSet" format="prims.fileset.zip" label="${tool.name} (to MzIdentML) on ${on_string} "/>
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
84 </change_format>
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
85 </data>
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
86 </outputs>
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
87 <tests>
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
88 </tests>
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
89 <help>
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
90
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
91 .. class:: infomark
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
92
9
c317e0f939df Made converter more robust and added support for mzXML in xtandem interface
pieter.lukasse@wur.nl
parents: 0
diff changeset
93 This tool translates X!Tandem, OMSSA or Proteome Discoverer peptide identification results to mzIdentML format.
0
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
94 It uses the library at http://code.google.com/p/mzidentml-parsers/
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
95 -----
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
96
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
97
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
98 </help>
d6001e8d7441 Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
99 </tool>