annotate profiler.xml @ 27:f996339050ac draft

Uploaded
author bgruening
date Sat, 14 Dec 2013 16:13:11 -0500
parents df9f0dbb1d2a
children 2e5b92e7f3cb
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
24
e43b4015b4cc Uploaded
bgruening
parents: 22
diff changeset
1 <tool id="deeptools_profiler" name="profiler" version="1.0.2">
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
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
49 $advancedOpt.onePlotPerGroup
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
50
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
51 #if $advancedOpt.yMin:
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
52 --yMin $advancedOpt.yMin
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
53 #end if
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
54 #if $advancedOpt.yMax:
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
55 --yMax $advancedOpt.yMax
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
56 #end if
1
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
57
10
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
58 --xAxisLabel '$advancedOpt.xAxisLabel'
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
59 #if str($advancedOpt.yAxisLabel.value) != "None":
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
60 --yAxisLabel '$advancedOpt.yAxisLabel'
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
61 #end if
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
62 #end if
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
63 </command>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
64 <inputs>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
65 <param name="matrixFile" format="bgzip" type="data" label="Matrix file from the computeMatrix tool"/>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
66 <conditional name="scaleRegions">
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
67 <param name="showScaleRegionsOpt" type="select" label="The input matrix was computed in scale-regions mode">
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
68 <option value="no" selected="true">no</option>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
69 <option value="yes">yes</option>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
70 </param>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
71 <when value="no" />
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
72 <when value="yes">
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
73 <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
74 <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
75 </when>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
76 </conditional>
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
77
27
f996339050ac Uploaded
bgruening
parents: 25
diff changeset
78 <expand macro="input_graphic_output_settings">
25
df9f0dbb1d2a Uploaded
bgruening
parents: 24
diff changeset
79 <expand macro="input_image_file_format" />
df9f0dbb1d2a Uploaded
bgruening
parents: 24
diff changeset
80 </expand>
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
81
10
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
82 <conditional name="advancedOpt">
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
83 <param name="showAdvancedOpt" type="select" label="Show advanced options" >
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
84 <option value="no" selected="true">no</option>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
85 <option value="yes">yes</option>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
86 </param>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
87 <when value="no" />
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
88 <when value="yes">
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
89 <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
90 <option value="mean" selected="true">mean</option>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
91 <option value="median">median</option>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
92 <option value="min">min</option>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
93 <option value="max">max</option>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
94 <option value="sum">sum</option>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
95 <option value="std">std</option>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
96 </param>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
97 <param name="plotHeight" type="integer" value="5" min="3"
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
98 label="Plot height"
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
99 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
100 <param name="plotWidth" type="integer" value="8" min="1"
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
101 label="Plot width"
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
102 help="Width in cm. The default value is 8 centimeters. The minimum value is 1 cm." />
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
103 <param name="plotType" type="select" label="Plot type"
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
104 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.">
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
105 <option value="lines" selected="true">lines</option>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
106 <option value="fill">fill</option>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
107 <option value="std">std</option>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
108 <option value="overlapped_lines">overlapped lines</option>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
109 </param>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
110 <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
111 <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." />
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
112 <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
113 <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
114 <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
115 <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
116 <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
117 </when>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
118 </conditional>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
119 </inputs>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
120 <outputs>
27
f996339050ac Uploaded
bgruening
parents: 25
diff changeset
121 <expand macro="output_image_file_format" />
f996339050ac Uploaded
bgruening
parents: 25
diff changeset
122 <expand macro="output_graphic_outputs" />
22
8710187d1eb5 Uploaded
bgruening
parents: 10
diff changeset
123 </outputs>
8710187d1eb5 Uploaded
bgruening
parents: 10
diff changeset
124 <help>
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
125
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
126 **What it does**
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
127
10
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
128 This tool plots the average enrichments over all genomic
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
129 regions supplied to computeMarix. It is a very useful complement to the
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
130 heatmapper, especially in cases when you want to compare the scores for
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
131 many different groups. Like heatmapper, profiler does not change the
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
132 values that were compute by computeMatrix, but you can choose between
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
133 many different ways to color and display the plots.
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
134
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
135
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
136 .. image:: $PATH_TO_IMAGES/visual_profiler_DmelPolII.png
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
137 :alt: Meta-gene profile of Rna Polymerase II
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
138
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
139
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
140 -----
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
141
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
142 .. class:: infomark
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
143
10
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
144 @REFERENCES@
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
145
10
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
146 </help>
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
147 </tool>