annotate sedmat.xml @ 8:39cd94fc6bbe

Added validation to avoid errors in which the user adds the same sample/run twice or more by mistake.
author pieter.lukasse@wur.nl
date Thu, 06 Mar 2014 16:47:49 +0100
parents d1edc7971d48
children 08e93cd411b9
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
1 <tool name="SedMat" id="sedmat1" version="1.0.2">
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
2 <description>Matches MS and MS/MS results</description>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
3 <!--
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
4 For remote debugging start you listener on port 8000 and use the following as command interpreter:
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
5 java -jar -Xdebug -Xrunjdwp:transport=dt_socket,address=D0100564.wurnet.nl:8000
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
6 -->
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
7 <command interpreter="java -jar ">
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
8 SedMat_cli.jar
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
9 -pl $inputMS
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
10 -plInputFormat apml
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
11 -ppids $fileType.inputFormatType.ppidsFile
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
12 -ppidsFileGrouping $fileType.type
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
13 -ppidsInputFormat $fileType.inputFormatType.ppidsInputFormat
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
14 -ppidsFileDescription $fileType.inputFormatType.ppidsFile.name
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
15 #if $fileType.inputFormatType.ppidsInputFormat == "mzid"
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
16 -spectraDataFile $fileType.inputFormatType.spectraDataFile
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
17 #end if
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
18 -out $outputData
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
19 -outUnmatchedMS2 $outUnmatchedMS2
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
20 -mtol $mtol
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
21 -rttol $rttol
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
22 -rtShiftDetectionWindow $rtShiftDetectionWindow
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
23 -matchOnSameSourceOnly $matchOnSameSourceOnly
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
24 -chargeStatesToGenerate $chargeStatesToGenerate
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
25 -outReport $htmlReportFile
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
26 -outReportPicturesPath $htmlReportFile.files_path
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
27 #if $troubleshoot1.troubleshootPeakLocations == True
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
28 -troubleshootPeakLocations YES
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
29 -mStart $troubleshoot1.mStart
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
30 -mEnd $troubleshoot1.mEnd
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
31 -rtStart $troubleshoot1.rtStart
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
32 -rtEnd $troubleshoot1.rtEnd
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
33 -filterSourceName $troubleshoot1.filterSourceName
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
34 #end if
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
35 #if $matchOnNamingConvention.match == True
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
36 -matchOnNamingConvention YES
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
37 -namingConventionCodesForMatching $matchOnNamingConvention.namingConventionCodesForMatching
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
38 #end if
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
39
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
40 </command>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
41
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
42 <inputs>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
43
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
44 <param name="inputMS" type="data" format="apml" label="MS data (APML format)" />
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
45 <!-- possible option <validator type="metadata" check="base_name" message="Metadata missing, click the pencil icon in the history item and set base_name."/> -->
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
46
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
47 <conditional name="fileType">
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
48 <param name="type" type="select" label="Peptide identification file grouping type">
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
49 <option value="single" selected="true">single-File</option>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
50 <option value="fileSet">fileSet</option>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
51 </param>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
52 <when value="single">
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
53 <conditional name="inputFormatType">
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
54 <param name="ppidsInputFormat" type="select" label="MS/MS input format">
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
55 <option value="mzid" selected="true">mzIdentML on mzML</option>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
56 <option value="apml">APML</option>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
57 </param>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
58 <when value="mzid">
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
59 <param name="spectraDataFile" type="data" format="mzml" label="MS/MS spectra file (mzml)"/>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
60 <param name="ppidsFile" type="data" format="mzid" label="MS/MS peptide identifications file (mzidentml)"/>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
61 </when>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
62 <when value="apml">
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
63 <param name="ppidsFile" type="data" format="apml" label="MS/MS peptide identifications file (apml)">
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
64 <!-- TODO - find out how to use
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
65 <validator type="expression" message="You already selected this file as the MS data file.">value.id == inputMS,{"inputMS":$inputMS},{}</validator>-->
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
66 </param>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
67 </when>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
68 </conditional>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
69 </when>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
70 <when value="fileSet">
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
71 <conditional name="inputFormatType">
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
72 <param name="ppidsInputFormat" type="select" label="inputFormat">
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
73 <option value="mzid" selected="true">mzIdentML on mzML</option>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
74 </param>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
75 <when value="mzid">
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
76 <param name="spectraDataFile" type="data" format="prims.fileset.zip" label="MS/MS spectra fileSet (N mzml files)"/>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
77 <param name="ppidsFile" type="data" format="prims.fileset.zip" label="MS/MS peptide identifications fileSet (N mzidentml files)"/>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
78 </when>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
79 </conditional>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
80 </when>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
81 </conditional>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
82 <param name="mtol" type="integer" size="10" value="50" label="m/z tolerance (ppm) " />
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
83 <param name="rttol" type="integer" size="10" value="150" label="Rention time tolerance (seconds) " />
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
84 <param name="rtShiftDetectionWindow" type="integer" size="10" value="20" label="Rention time shift detection window (seconds) " help="Size of the window to use for average rt shift calculations"/>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
85
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
86 <param name="matchOnSameSourceOnly" type="boolean" checked="false" label="Match peaks from same source only" help="If you want this, you might have to inform how to match the source files"/>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
87 <conditional name="matchOnNamingConvention">
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
88 <param name="match" type="boolean" truevalue="Yes" falsevalue="No" checked="false" label="Match using naming convention" help="Use a list of codes that occur in the file names and that link them together."/>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
89 <when value="Yes">
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
90 <param name="namingConventionCodesForMatching" type="text" size="100" value="" label="List of codes in naming convention" help="Add the CSV list of codes that occur in the file names and that link them together. E.g. '_F1,_F2,_F3,etc.'"/>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
91 </when>
6
d1edc7971d48 fixes in tool forms (<when> tags)
pieter.lukasse@wur.nl
parents: 0
diff changeset
92 <when value="No">
d1edc7971d48 fixes in tool forms (<when> tags)
pieter.lukasse@wur.nl
parents: 0
diff changeset
93 </when>
0
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
94 </conditional>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
95
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
96 <param name="chargeStatesToGenerate" type="select" display="checkboxes" multiple="true" label="Generate extra charge states" help="The selected charge states will be generated for each MS2 feature ">
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
97 <option value="1" selected="true">1</option>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
98 <option value="2" selected="true">2</option>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
99 <option value="3" selected="true">3</option>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
100 <option value="4" selected="true">4</option>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
101 <option value="5">5</option>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
102 </param>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
103
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
104 <param name="summaryReport" type="boolean" checked="true" label="Generate summary report" help="NB: this will increase the processing time"/>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
105
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
106 <conditional name="troubleshoot1">
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
107 <param name="troubleshootPeakLocations" type="boolean" truevalue="Yes" falsevalue="No" checked="false" label="Troubleshoot ms1/ms2 peak locations" help="Small trial run to check if the MS and MS/MS peak lists in their current states can easily be matched "/>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
108 <when value="Yes">
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
109 <param name="mStart" optional="false" type="integer" size="10" value="100" label="Set m/z start " />
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
110 <param name="mEnd" optional="false" type="integer" size="10" value="1000" label="Set m/z end " />
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
111 <param name="rtStart" optional="false" type="integer" size="10" value="10" label="Set rention time start (minutes) " />
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
112 <param name="rtEnd" optional="false" type="integer" size="10" value="20" label="Set rention time end (minutes) " />
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
113 <param name="filterSourceName" type="text" size="100" value="" label="Restrict matching to a specific subset of the files " help="Part of a file name that occurs in both a ms1 and ms2 file (e.g. 'RibO_1_msE1')"/>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
114 </when>
6
d1edc7971d48 fixes in tool forms (<when> tags)
pieter.lukasse@wur.nl
parents: 0
diff changeset
115 <when value="No">
d1edc7971d48 fixes in tool forms (<when> tags)
pieter.lukasse@wur.nl
parents: 0
diff changeset
116 </when>
0
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
117 </conditional>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
118
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
119 </inputs>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
120 <outputs>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
121 <data name="outputData" format="apml" label="${inputMS.metadata.base_name} - ${tool.name} on ${on_string}: APML" metadata_source="inputMS"></data>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
122 <data name="outUnmatchedMS2" format="csv" label="${inputMS.metadata.base_name} - ${tool.name} on ${on_string}: unmatched MS2 features CSV" metadata_source="inputMS"></data>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
123 <data name="htmlReportFile" format="html" label="${tool.name} on ${on_string} - HTML report">
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
124 <!-- If the expression is false, the file is not created -->
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
125 <filter>( summaryReport == True )</filter>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
126 </data>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
127 </outputs>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
128 <tests>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
129 <!-- find out how to use -->
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
130 <test>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
131 </test>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
132 </tests>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
133 <help>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
134
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
135 .. class:: infomark
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
136
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
137 This tool matches MS and MS/MS results. SEDMAT stands for "Single Experiment Data Matching Tool".
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
138 It can match peaks found in the MS spectra with the peptides found using the MS/MS spectra.
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
139 The result is the list of MS peaks annotated with peptides and proteins.
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
140
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
141 -----
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
142
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
143 **Output example**
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
144
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
145 This tools returns APML output, a Cytoscape network (.xgmml) of the matches and Retention Time plots (.pdf).
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
146
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
147 </help>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
148 </tool>