annotate profiler.xml @ 1:a22ccc261bb3 draft

Uploaded
author bgruening
date Fri, 15 Nov 2013 07:57:48 -0500
parents d957e25e18a3
children 135f3bae5c56
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
1 <tool id="deeptools_profiler" name="profiler" version="1.0">
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
2 <description>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
3 creates a profile plot for a score associated to genomic regions
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
4 </description>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
5 <expand macro="requirements" />
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
6 <macros>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
7 <import>deepTools_macros.xml</import>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
8 </macros>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
9 <command>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
10 profiler
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
11
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
12 --matrixFile $matrixFile
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
13
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
14 #if $output.showOutputSettings == "yes"
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
15 #set newoutFileName = str($outFileName)+"."+str($output.outFileFormat)
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
16 --outFileName $newoutFileName
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
17
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
18 #if $output.saveData:
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
19 --outFileNameData '$outFileNameData'
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
20 #end if
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
21
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
22 #if $output.saveMatrix:
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
23 --outFileNameMatrix '$outFileNameMatrix'
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
24 #end if
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
25
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
26 #if $output.saveSortedRegions:
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
27 --outFileSortedRegions '$outFileSortedRegions'
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
28 #end if
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
29 #else
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
30 #set newoutFileName = str($outFileName)+".png"
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
31 --outFileName $newoutFileName
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
32 #end if
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
33
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
34 #if $scaleRegions.showScaleRegionsOpt == "yes":
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
35 --startLabel $scaleRegions.startLabel
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
36 --endLabel $scaleRegions.endLabel
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
37 #end if
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
38
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
39 #if $advancedOpt.showAdvancedOpt == "yes":
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
40 #if $advancedOpt.averageType:
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
41 --averageType '$advancedOpt.averageType'
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
42 #end if
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
43 --plotHeight $advancedOpt.plotHeight
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
44 --plotWidth $advancedOpt.plotWidth
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
45 --plotType $advancedOpt.plotType
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
46
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
47 --regionsLabel '$advancedOpt.regionsLabel'
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
48
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
49 #if str($advancedOpt.plotTitle.value) != "None":
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
50 --plotTitle '$advancedOpt.plotTitle'
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
51 #end if
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
52
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
53 $advancedOpt.onePlotPerGroup
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
54
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
55 #if $advancedOpt.yMin:
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
56 --yMin $advancedOpt.yMin
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
57 #end if
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
58 #if $advancedOpt.yMax:
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
59 --yMax $advancedOpt.yMax
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
60 #end if
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
61
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
62 --xAxisLabel '$advancedOpt.xAxisLabel'
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
63 #if str($advancedOpt.yAxisLabel.value) != "None":
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
64 --yAxisLabel '$advancedOpt.yAxisLabel'
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
65 #end if
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
66 #end if
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
67 ; mv $newoutFileName $outFileName
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
68 </command>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
69 <inputs>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
70 <param name="matrixFile" format="bgzip" type="data" label="Matrix file from the computeMatrix tool"/>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
71 <conditional name="scaleRegions">
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
72 <param name="showScaleRegionsOpt" type="select" label="The input matrix was computed in scale-regions mode">
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
73 <option value="no" selected="true">no</option>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
74 <option value="yes">yes</option>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
75 </param>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
76 <when value="no" />
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
77 <when value="yes">
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
78 <param name="startLabel" type="text" value="TSS" size="10" label="Label for the region start" help ="[only for scale-regions mode] Label shown in the plot for the start of the region. Default is TSS (transcription start site), but could be changed to anything, e.g. &quot;peak start&quot;." />
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
79 <param name="endLabel" type="text" value="TES" size="10" label="Label for the region end" help="[only for scale-regions mode] Label shown in the plot for the region end. Default is TES (transcription end site)."/>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
80 </when>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
81 </conditional>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
82
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
83 <expand macro="graphic_output_settings" />
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
84
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
85 <conditional name="advancedOpt">
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
86 <param name="showAdvancedOpt" type="select" label="Show advanced options" >
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
87 <option value="no" selected="true">no</option>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
88 <option value="yes">yes</option>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
89 </param>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
90 <when value="no" />
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
91 <when value="yes">
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
92 <param name="averageType" type="select" label="Define the type of statistic that should be used for the profile.">
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
93 <option value="mean" selected="true">mean</option>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
94 <option value="median">median</option>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
95 <option value="min">min</option>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
96 <option value="max">max</option>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
97 <option value="sum">sum</option>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
98 <option value="std">std</option>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
99 </param>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
100 <param name="plotHeight" type="integer" value="5" min="3"
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
101 label="Plot height"
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
102 help="Height in cm. The default for the plot height is 5 centimeters. The minimum value is 3 cm." />
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
103 <param name="plotWidth" type="integer" value="8" min="1"
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
104 label="Plot width"
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
105 help="Width in cm. The default value is 8 centimeters. The minimum value is 1 cm." />
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
106 <param name="plotType" type="select" label="Plot type"
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
107 help="For the summary plot (profile) only. The &quot;lines&quot; option will plot the profile line based on the average type selected. The &quot;fill&quot; option fills the region between zero and the profile curve. The fill in color is semi transparent to distinguish different profiles. The &quot;std&quot; option colors the region between the profile and the standard deviation of the data. As in the case of fill, a semi-transparent color is used. The option &quot;overlapped_lines&quot; plots each region values, one on top of the other; this option only works if &quot;one plot per proup&quot; is set.">
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
108 <option value="lines" selected="true">lines</option>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
109 <option value="fill">fill</option>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
110 <option value="std">std</option>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
111 <option value="overlapped_lines">overlapped lines</option>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
112 </param>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
113
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
114 <param name="regionsLabel" type="text" value="genes" size="30" label="Labels for the regions plotted in the heatmap" help="If more than one region is being plotted a list of labels separated by comma and limited by quotes, is required. For example, &quot;label1, label2&quot;."/>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
115 <param name="plotTitle" type="text" value="" size="30" label="Title of the plot" help="Title of the plot, to be printed on top of the generated image. Leave blank for no title." />
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
116 <param name="onePlotPerGroup" type="boolean" truevalue="--onePlotPerGroup" falsevalue="" label="Do one plot per group" help="When the region file contains groups separated by &quot;#&quot;, the default is to plot the averages for the distinct plots in one plot. If this option is set, each group will get its own plot, stacked on top of each other."/>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
117 <param name="yMin" type="float" value="" size="3" label="Minimum value for the Y-axis of the summary plot. Leave empty for automatic values" optional="true"/>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
118 <param name="yMax" type="float" value="" size="3" label="Maximum value for Y-axis of the summary plot. Leave empty for automatic values" optional="true"/>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
119 <param name="xAxisLabel" type="text" value="gene distance (bp)" size="50" label="Description for the x-axis label" />
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
120 <param name="yAxisLabel" type="text" value="" size="50" label="Description for the y-axis label for the top panel" />
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
121 </when>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
122 </conditional>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
123 </inputs>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
124 <outputs>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
125 <data format="png" name="outFileName" label="${tool.name} image">
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
126 <change_format>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
127 <when input="output.outFileFormat" value="pdf" format="pdf" />
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
128 <when input="output.outFileFormat" value="svg" format="svg" />
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
129 <when input="output.outFileFormat" value="eps" format="eps" />
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
130 <when input="output.outFileFormat" value="emf" format="emf" />
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
131 </change_format>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
132 </data>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
133 <data format="tabular" name="outFileNameData" label="${tool.name} raw plot data">
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
134 <filter>(output['showOutputSettings'] == 'yes' and output['saveData'] == True)</filter>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
135 </data>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
136 <data format="tabular" name="outFileNameMatrix" label="${tool.name} matrix of heatmap values">
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
137 <filter>(output['showOutputSettings'] == 'yes' and output['saveMatrix'] == True)</filter>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
138 </data>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
139 <data format="bed" name="outFileSortedRegions" label="${tool.name} sorted/filtered regions">
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
140 <filter>(output['showOutputSettings'] == 'yes' and output['saveSortedRegions'] == True)</filter>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
141 </data>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
142 </outputs>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
143 <help>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
144
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
145 **What it does**
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
146
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
147 This tool plots the average enrichments over all genomic
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
148 regions supplied to computeMarix. It is a very useful complement to the
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
149 heatmapper, especially in cases when you want to compare the scores for
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
150 many different groups. Like heatmapper, profiler does not change the
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
151 values that were compute by computeMatrix, but you can choose between
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
152 many different ways to color and display the plots.
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
153
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
154
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
155 .. image:: $PATH_TO_IMAGES/visual_profiler_DmelPolII.png
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
156 :alt: Meta-gene profile of Rna Polymerase II
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
157
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
158
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
159 -----
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
160
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
161 .. class:: infomark
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
162
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
163 @REFERENCES@
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
164
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
165 </help>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
166 </tool>