annotate napq.xml @ 6:d1edc7971d48

fixes in tool forms (<when> tags)
author pieter.lukasse@wur.nl
date Fri, 31 Jan 2014 12:11:34 +0100
parents 5d99c9d0615d
children 72d4a37869ee
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="NapQ" id="napq" version="0.0.1">
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
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
23 <repeat name="identificationFileList" title="Peptide identification files" help="Full set of MS/MS peptide identification files, including peptides that could not be quantified.">
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 <param name="spectraFile" type="data" format="mzidentml,prims.fileset.zip" optional="true" label="(Optional) Spectra fileSet (mzml file or fileSet)"
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
26 help="Select this in case your Identifications file is MZIDENTML or MZIDENTML fileSet" />
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
27 </repeat>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
28
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
29 <param name="namingConventionCodesForSamples" type="text" size="100" value=""
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
30 label="Part of run/file name that identifies the sample"
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
31 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
32 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 -->
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
33
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
34
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
35 <conditional name="is2D_LC_MS">
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
36 <param name="fractions" type="boolean" truevalue="Yes" falsevalue="No" checked="false"
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
37 label="Data is from 2D LC-MS"
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
38 help="Data acquisition was done in multiple fractions."/>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
39 <when value="Yes">
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
40 <param name="namingConventionCodesForFractions" type="text" size="100" value=""
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
41 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
42 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
43 and that stand for a fraction code. E.g. '_F1,_F2,_F3,etc.' Use this to avoid
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
44 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 -->
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
45 </when>
6
d1edc7971d48 fixes in tool forms (<when> tags)
pieter.lukasse@wur.nl
parents: 5
diff changeset
46 <when value="No">
d1edc7971d48 fixes in tool forms (<when> tags)
pieter.lukasse@wur.nl
parents: 5
diff changeset
47 </when>
0
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
48 </conditional>
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 </inputs>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
51 <configfiles>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
52 <configfile name="identificationsConfigFile">## start comment
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
53 ## 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
54 #for $i, $s in enumerate( $identificationFileList )
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
55 ${s.identificationsFile}|${s.spectraFile}
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
56 ## 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
57 #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
58 apml
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
59 #else:
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
60 mzid
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
61 #end if
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
62 #end for
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
63 ## end comment</configfile>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
64 </configfiles>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
65 <outputs>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
66 <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
67 <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
68 <!-- 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
69 <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
70 <!-- 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
71 </outputs>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
72 <tests>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
73 </tests>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
74 <help>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
75
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
76 .. class:: infomark
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
77
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
78 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
79 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
80 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
81 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
82 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
83 their calculated quantifications at the sample level.
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
84
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
85 The figure below explains this:
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
86
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
87 .. image:: $PATH_TO_IMAGES/napq_overview.png
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
88
4
73c7c6589202 small fixes
pieter.lukasse@wur.nl
parents: 0
diff changeset
89 .
0
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
90
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
91
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
92
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
93
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
94 </help>
d50f079096ee Push to main toolshed
pieter.lukasse@wur.nl
parents:
diff changeset
95 </tool>