annotate napq.xml @ 20:125a6afa800c

fix to NapQ
author pieter.lukasse@wur.nl
date Mon, 26 Jan 2015 06:31:52 +0100
parents d31c6978d9d0
children 46f568202d46
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
17
40ec8770780d * Added support for pepxml (and more specifically for
pieter.lukasse@wur.nl
parents: 16
diff changeset
1 <tool name="NapQ" id="napq" version="0.0.3">
5
5d99c9d0615d performance improvements for MsFilt
pieter.lukasse@wur.nl
parents: 4
diff changeset
2 <description>'no alignment' (alignment-free) peptide quantification</description>
0
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 -->
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
8 <command interpreter="java -jar ">
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
9 NapQ.jar
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
10 -identificationsConfigFile $identificationsConfigFile
6
d1edc7971d48 fixes in tool forms (<when> tags)
pieter.lukasse@wur.nl
parents: 5
diff changeset
11 -namingConventionCodesForSamples "$namingConventionCodesForSamples"
0
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
12 #if $is2D_LC_MS.fractions == True
6
d1edc7971d48 fixes in tool forms (<when> tags)
pieter.lukasse@wur.nl
parents: 5
diff changeset
13 -namingConventionCodesForFractions "$is2D_LC_MS.namingConventionCodesForFractions"
0
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
14 #end if
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
15 -outputApml $outputApml
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
16 -outputTsv $outputTsv
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
17 -outReport $htmlReportFile
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
18 -outReportPicturesPath $htmlReportFile.files_path
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
19 </command>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
20
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
21 <inputs>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
22
16
d56c18ed0f77 fix in comment and in configuration
pieter.lukasse@wur.nl
parents: 10
diff changeset
23 <repeat name="identificationFileList" title="Peptide identification files" help="Set of MS/MS peptide identification files that have some form of quantification data coupled to it (e.g. MSE identifications&amp;intensity).">
0
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
24 <param name="identificationsFile" type="data" format="apml,mzidentml,prims.fileset.zip" label="Identifications file (APML or MZIDENTML or MZIDENTML fileSet)" />
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
25 </repeat>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
26
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
27 <param name="namingConventionCodesForSamples" type="text" size="100" value=""
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
28 label="Part of run/file name that identifies the sample"
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
29 help="Add the CSV list of codes that occur in the file names
19
d31c6978d9d0 fixes for NapQ
pieter.lukasse@wur.nl
parents: 17
diff changeset
30 and that stand for a sample code. E.g. '_S1,_S2,_S3,etc.' "> <!-- could do regular expressions as well but this would be hard for biologists, e.g. _F\d\b -->
d31c6978d9d0 fixes for NapQ
pieter.lukasse@wur.nl
parents: 17
diff changeset
31 <sanitizer>
d31c6978d9d0 fixes for NapQ
pieter.lukasse@wur.nl
parents: 17
diff changeset
32 <!-- adding more characters to the set of "valid" ones: -->
d31c6978d9d0 fixes for NapQ
pieter.lukasse@wur.nl
parents: 17
diff changeset
33 <valid>
d31c6978d9d0 fixes for NapQ
pieter.lukasse@wur.nl
parents: 17
diff changeset
34 <add preset="string.printable"/>
d31c6978d9d0 fixes for NapQ
pieter.lukasse@wur.nl
parents: 17
diff changeset
35 <add value="#"/>
d31c6978d9d0 fixes for NapQ
pieter.lukasse@wur.nl
parents: 17
diff changeset
36 <add value="@"/>
d31c6978d9d0 fixes for NapQ
pieter.lukasse@wur.nl
parents: 17
diff changeset
37 <add value="$"/>
d31c6978d9d0 fixes for NapQ
pieter.lukasse@wur.nl
parents: 17
diff changeset
38 <add value="%"/>
d31c6978d9d0 fixes for NapQ
pieter.lukasse@wur.nl
parents: 17
diff changeset
39 <add value="&"/>
d31c6978d9d0 fixes for NapQ
pieter.lukasse@wur.nl
parents: 17
diff changeset
40 <add value="*"/>
d31c6978d9d0 fixes for NapQ
pieter.lukasse@wur.nl
parents: 17
diff changeset
41 <add value="["/>
d31c6978d9d0 fixes for NapQ
pieter.lukasse@wur.nl
parents: 17
diff changeset
42 <add value="]"/>
d31c6978d9d0 fixes for NapQ
pieter.lukasse@wur.nl
parents: 17
diff changeset
43 <add value="|"/>
d31c6978d9d0 fixes for NapQ
pieter.lukasse@wur.nl
parents: 17
diff changeset
44 <add value="{"/>
d31c6978d9d0 fixes for NapQ
pieter.lukasse@wur.nl
parents: 17
diff changeset
45 <add value="}"/>
d31c6978d9d0 fixes for NapQ
pieter.lukasse@wur.nl
parents: 17
diff changeset
46 </valid>
d31c6978d9d0 fixes for NapQ
pieter.lukasse@wur.nl
parents: 17
diff changeset
47 </sanitizer>
d31c6978d9d0 fixes for NapQ
pieter.lukasse@wur.nl
parents: 17
diff changeset
48 </param>
0
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
49
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
50 <conditional name="is2D_LC_MS">
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
51 <param name="fractions" type="boolean" truevalue="Yes" falsevalue="No" checked="false"
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
52 label="Data is from 2D LC-MS"
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
53 help="Data acquisition was done in multiple fractions."/>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
54 <when value="Yes">
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
55 <param name="namingConventionCodesForFractions" type="text" size="100" value=""
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
56 label="Part of run/file name that identifies the 2D LC-MS fraction"
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
57 help="Add the CSV list of codes that occur in the file names
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
58 and that stand for a fraction code. E.g. '_F1,_F2,_F3,etc.' Use this to avoid
19
d31c6978d9d0 fixes for NapQ
pieter.lukasse@wur.nl
parents: 17
diff changeset
59 that each (fraction) file is seen as a separate run."> <!-- could do regular expressions as well but this would be hard for biologists, e.g. _F\d\b -->
d31c6978d9d0 fixes for NapQ
pieter.lukasse@wur.nl
parents: 17
diff changeset
60 <sanitizer>
d31c6978d9d0 fixes for NapQ
pieter.lukasse@wur.nl
parents: 17
diff changeset
61 <!-- adding more characters to the set of "valid" ones: -->
d31c6978d9d0 fixes for NapQ
pieter.lukasse@wur.nl
parents: 17
diff changeset
62 <valid>
d31c6978d9d0 fixes for NapQ
pieter.lukasse@wur.nl
parents: 17
diff changeset
63 <add preset="string.printable"/>
d31c6978d9d0 fixes for NapQ
pieter.lukasse@wur.nl
parents: 17
diff changeset
64 <add value="#"/>
d31c6978d9d0 fixes for NapQ
pieter.lukasse@wur.nl
parents: 17
diff changeset
65 <add value="@"/>
d31c6978d9d0 fixes for NapQ
pieter.lukasse@wur.nl
parents: 17
diff changeset
66 <add value="$"/>
d31c6978d9d0 fixes for NapQ
pieter.lukasse@wur.nl
parents: 17
diff changeset
67 <add value="%"/>
d31c6978d9d0 fixes for NapQ
pieter.lukasse@wur.nl
parents: 17
diff changeset
68 <add value="&"/>
d31c6978d9d0 fixes for NapQ
pieter.lukasse@wur.nl
parents: 17
diff changeset
69 <add value="*"/>
d31c6978d9d0 fixes for NapQ
pieter.lukasse@wur.nl
parents: 17
diff changeset
70 <add value="["/>
d31c6978d9d0 fixes for NapQ
pieter.lukasse@wur.nl
parents: 17
diff changeset
71 <add value="]"/>
d31c6978d9d0 fixes for NapQ
pieter.lukasse@wur.nl
parents: 17
diff changeset
72 <add value="|"/>
d31c6978d9d0 fixes for NapQ
pieter.lukasse@wur.nl
parents: 17
diff changeset
73 <add value="{"/>
d31c6978d9d0 fixes for NapQ
pieter.lukasse@wur.nl
parents: 17
diff changeset
74 <add value="}"/>
d31c6978d9d0 fixes for NapQ
pieter.lukasse@wur.nl
parents: 17
diff changeset
75 </valid>
d31c6978d9d0 fixes for NapQ
pieter.lukasse@wur.nl
parents: 17
diff changeset
76 </sanitizer>
d31c6978d9d0 fixes for NapQ
pieter.lukasse@wur.nl
parents: 17
diff changeset
77 </param>
d31c6978d9d0 fixes for NapQ
pieter.lukasse@wur.nl
parents: 17
diff changeset
78
0
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
79 </when>
6
d1edc7971d48 fixes in tool forms (<when> tags)
pieter.lukasse@wur.nl
parents: 5
diff changeset
80 <when value="No">
d1edc7971d48 fixes in tool forms (<when> tags)
pieter.lukasse@wur.nl
parents: 5
diff changeset
81 </when>
0
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
82 </conditional>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
83
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
84 </inputs>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
85 <configfiles>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
86 <configfile name="identificationsConfigFile">## start comment
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
87 ## iterate over the selected files and store their names in the config file
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
88 #for $i, $s in enumerate( $identificationFileList )
16
d56c18ed0f77 fix in comment and in configuration
pieter.lukasse@wur.nl
parents: 10
diff changeset
89 ${s.identificationsFile}
0
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
90 ## also print out the datatype in the next line, based on previously configured datatype
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
91 #if isinstance( $s.identificationsFile.datatype, $__app__.datatypes_registry.get_datatype_by_extension('apml').__class__):
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
92 apml
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
93 #else:
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
94 mzid
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
95 #end if
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
96 #end for
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
97 ## end comment</configfile>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
98 </configfiles>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
99 <outputs>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
100 <data name="outputApml" format="apml" label="${tool.name} on ${on_string}: peptide quantifications (APML)"/>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
101 <data name="outputTsv" format="tabular" label="${tool.name} on ${on_string}: peptide quantifications (TSV)"/>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
102 <!-- in tsv we can have cols like: pep, avg_m/z, avg rt, m/z window, rt window, i_s1, i_s2, ...-->
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
103 <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
104 <!-- here we show the samples extracted and the files used to 'build up' each sample -->
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
105 </outputs>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
106 <tests>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
107 </tests>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
108 <help>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
109
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
110 .. class:: infomark
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
111
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
112 This tool takes in multiple peptide identification result files that have peptide identifications
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
113 coupled to some quantification (e.g. precursor intensity information or for example data coming
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
114 from MS^E acquisition where peptide identification and quantification are done in the same run and reported together).
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
115 Then, based on the given experiment design parameters (i.e. how the result files related back to
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
116 replicate runs and samples), it produces a new file in which the peptides are reported with
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
117 their calculated quantifications at the sample level.
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 The figure below explains this:
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
120
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
121 .. image:: $PATH_TO_IMAGES/napq_overview.png
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
122
4
73c7c6589202 small fixes
pieter.lukasse@wur.nl
parents: 0
diff changeset
123 .
0
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
124
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
125
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
126
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
127
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
128 </help>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
129 </tool>