annotate profiler.xml @ 33:fc3830717e24 draft

Uploaded
author bgruening
date Tue, 28 Jan 2014 16:30:41 -0500
parents 3f2096404113
children 934b9fccabd4
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
33
fc3830717e24 Uploaded
bgruening
parents: 32
diff changeset
1 <tool id="deeptools_profiler" name="profiler" version="1.0.3">
10
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
2 <description>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
3 creates a profile plot for a score associated to genomic regions
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
4 </description>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
5 <expand macro="requirements" />
22
8710187d1eb5 Uploaded
bgruening
parents: 10
diff changeset
6 <expand macro="stdio" />
10
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
7 <macros>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
8 <import>deepTools_macros.xml</import>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
9 </macros>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
10 <command>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
11 profiler
1
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
12
10
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
13 --matrixFile $matrixFile
24
e43b4015b4cc Uploaded
bgruening
parents: 22
diff changeset
14 --outFileName $outFileName
10
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
15
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
16 #if $output.showOutputSettings == "yes"
24
e43b4015b4cc Uploaded
bgruening
parents: 22
diff changeset
17 --plotFileFormat $output.outFileFormat
1
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
18
10
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
19 #if $output.saveData:
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
20 --outFileNameData '$outFileNameData'
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
21 #end if
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
22
10
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
23 #if $output.saveSortedRegions:
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
24 --outFileSortedRegions '$outFileSortedRegions'
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
25 #end if
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
26 #else
24
e43b4015b4cc Uploaded
bgruening
parents: 22
diff changeset
27 --plotFileFormat 'png'
10
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
28 #end if
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
29
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
30 #if $scaleRegions.showScaleRegionsOpt == "yes":
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
31 --startLabel $scaleRegions.startLabel
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
32 --endLabel $scaleRegions.endLabel
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
33 #end if
1
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
34
10
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
35 #if $advancedOpt.showAdvancedOpt == "yes":
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
36 #if $advancedOpt.averageType:
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
37 --averageType '$advancedOpt.averageType'
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
38 #end if
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
39 --plotHeight $advancedOpt.plotHeight
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
40 --plotWidth $advancedOpt.plotWidth
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
41 --plotType $advancedOpt.plotType
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
42
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
43 --regionsLabel '$advancedOpt.regionsLabel'
1
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
44
10
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
45 #if str($advancedOpt.plotTitle.value) != "None":
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
46 --plotTitle '$advancedOpt.plotTitle'
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
47 #end if
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
48
30
2e5b92e7f3cb Uploaded
bgruening
parents: 27
diff changeset
49 #if str($advancedOpt.colors.value) != "None":
32
3f2096404113 Uploaded
bgruening
parents: 31
diff changeset
50 --colors #echo ' '.join( ["'%s'" % $color for $color in $advancedOpt.colors.split()] )#
30
2e5b92e7f3cb Uploaded
bgruening
parents: 27
diff changeset
51 #end if
2e5b92e7f3cb Uploaded
bgruening
parents: 27
diff changeset
52
10
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
53 $advancedOpt.onePlotPerGroup
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
54
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
55 #if $advancedOpt.yMin:
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
56 --yMin $advancedOpt.yMin
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
57 #end if
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
58 #if $advancedOpt.yMax:
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
59 --yMax $advancedOpt.yMax
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
60 #end if
1
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
61
10
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
62 --xAxisLabel '$advancedOpt.xAxisLabel'
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
63 #if str($advancedOpt.yAxisLabel.value) != "None":
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
64 --yAxisLabel '$advancedOpt.yAxisLabel'
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
65 #end if
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
66 #end if
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
67 </command>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
68 <inputs>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
69 <param name="matrixFile" format="bgzip" type="data" label="Matrix file from the computeMatrix tool"/>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
70 <conditional name="scaleRegions">
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
71 <param name="showScaleRegionsOpt" type="select" label="The input matrix was computed in scale-regions mode">
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
72 <option value="no" selected="true">no</option>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
73 <option value="yes">yes</option>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
74 </param>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
75 <when value="no" />
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
76 <when value="yes">
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
77 <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;." />
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
78 <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)."/>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
79 </when>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
80 </conditional>
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
81
27
f996339050ac Uploaded
bgruening
parents: 25
diff changeset
82 <expand macro="input_graphic_output_settings">
25
df9f0dbb1d2a Uploaded
bgruening
parents: 24
diff changeset
83 <expand macro="input_image_file_format" />
df9f0dbb1d2a Uploaded
bgruening
parents: 24
diff changeset
84 </expand>
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
85
10
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
86 <conditional name="advancedOpt">
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
87 <param name="showAdvancedOpt" type="select" label="Show advanced options" >
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
88 <option value="no" selected="true">no</option>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
89 <option value="yes">yes</option>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
90 </param>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
91 <when value="no" />
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
92 <when value="yes">
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
93 <param name="averageType" type="select" label="Define the type of statistic that should be used for the profile.">
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
94 <option value="mean" selected="true">mean</option>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
95 <option value="median">median</option>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
96 <option value="min">min</option>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
97 <option value="max">max</option>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
98 <option value="sum">sum</option>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
99 <option value="std">std</option>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
100 </param>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
101 <param name="plotHeight" type="integer" value="5" min="3"
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
102 label="Plot height"
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
103 help="Height in cm. The default for the plot height is 5 centimeters. The minimum value is 3 cm." />
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
104 <param name="plotWidth" type="integer" value="8" min="1"
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
105 label="Plot width"
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
106 help="Width in cm. The default value is 8 centimeters. The minimum value is 1 cm." />
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
107 <param name="plotType" type="select" label="Plot type"
30
2e5b92e7f3cb Uploaded
bgruening
parents: 27
diff changeset
108 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;add standard error&quot; option colors the region between the profile and the standard error 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.">
10
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
109 <option value="lines" selected="true">lines</option>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
110 <option value="fill">fill</option>
30
2e5b92e7f3cb Uploaded
bgruening
parents: 27
diff changeset
111 <option value="se">add standard error</option>
10
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
112 <option value="overlapped_lines">overlapped lines</option>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
113 </param>
a68a771625d2 Uploaded
bgruening
parents: 9
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;."/>
a68a771625d2 Uploaded
bgruening
parents: 9
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." />
32
3f2096404113 Uploaded
bgruening
parents: 31
diff changeset
116 <param name="colors" type="text" value="" size="40" label="List of colors to use for the plotted lines" help="Color names and html hex strings (e.g. #eeff22) are accepted. The color names should be given separated by spaces. (--colors red blue green)">
3f2096404113 Uploaded
bgruening
parents: 31
diff changeset
117 <validator type="expression" message="Only numbers, digits, '#' and spaces are allowed.">all(c in ' #abcdefghijklmnopqrstuvwxyz0123456789' for c in value)</validator>
30
2e5b92e7f3cb Uploaded
bgruening
parents: 27
diff changeset
118 </param>
2e5b92e7f3cb Uploaded
bgruening
parents: 27
diff changeset
119
10
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
120 <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."/>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
121 <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"/>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
122 <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"/>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
123 <param name="xAxisLabel" type="text" value="gene distance (bp)" size="50" label="Description for the x-axis label" />
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
124 <param name="yAxisLabel" type="text" value="" size="50" label="Description for the y-axis label for the top panel" />
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
125 </when>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
126 </conditional>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
127 </inputs>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
128 <outputs>
27
f996339050ac Uploaded
bgruening
parents: 25
diff changeset
129 <expand macro="output_image_file_format" />
f996339050ac Uploaded
bgruening
parents: 25
diff changeset
130 <expand macro="output_graphic_outputs" />
22
8710187d1eb5 Uploaded
bgruening
parents: 10
diff changeset
131 </outputs>
8710187d1eb5 Uploaded
bgruening
parents: 10
diff changeset
132 <help>
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
133
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
134 **What it does**
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
135
10
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
136 This tool plots the average enrichments over all genomic
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
137 regions supplied to computeMarix. It is a very useful complement to the
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
138 heatmapper, especially in cases when you want to compare the scores for
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
139 many different groups. Like heatmapper, profiler does not change the
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
140 values that were compute by computeMatrix, but you can choose between
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
141 many different ways to color and display the plots.
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
142
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
143
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
144 .. image:: $PATH_TO_IMAGES/visual_profiler_DmelPolII.png
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
145 :alt: Meta-gene profile of Rna Polymerase II
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
146
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
147
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
148 -----
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
149
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
150 .. class:: infomark
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
151
10
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
152 @REFERENCES@
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
153
10
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
154 </help>
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
155 </tool>