annotate computeMatrix.xml @ 29:3a2aab18a217 draft

Uploaded
author bgruening
date Tue, 16 Sep 2014 13:46:05 -0400
parents f7712a057440
children 5231f398d784
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
28
f7712a057440 new bugfix release
bgruening
parents: 27
diff changeset
1 <tool id="deeptools_computeMatrix" name="computeMatrix" version="@WRAPPER_VERSION@.0">
26
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
2 <description>summarizes and prepares an intermediary file containing scores associated with genomic regions that can be used afterwards to plot a heatmap or a profile</description>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
3 <expand macro="requirements" />
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
4 <expand macro="stdio" />
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
5 <macros>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
6 <token name="@BINARY@">computeMatrix</token>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
7 <import>deepTools_macros.xml</import>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
8 </macros>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
9 <command>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
10 #import tempfile
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
11
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
12 #set $temp_input_handle = tempfile.NamedTemporaryFile()
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
13 #set $temp_input_path = $temp_input_handle.name
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
14 #silent $temp_input_handle.close()
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
15
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
16 #for $rf in $regionsFiles:
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
17 cat "$rf.regionsFile" >> $temp_input_path;
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
18 #if str($rf.label.value).strip():
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
19 echo "\#$rf.label.value" >> $temp_input_path;
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
20 #else:
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
21 echo "\#$rf.regionsFile.name" >> $temp_input_path;
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
22 #end if
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
23 #end for
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
24
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
25
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
26 computeMatrix
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
27
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
28 $mode.mode_select
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
29 --regionsFileName '$temp_input_path'
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
30 --scoreFileName '$scoreFile'
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
31 --outFileName '$outFileName'
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
32
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
33 @THREADS@
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
34
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
35 #if $output.showOutputSettings == "yes"
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
36 #if $output.saveData:
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
37 --outFileNameData '$outFileNameData'
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
38 #end if
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
39 #if $output.saveMatrix:
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
40 --outFileNameMatrix '$outFileNameMatrix'
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
41 #end if
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
42
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
43 #if $output.saveSortedRegions:
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
44 --outFileSortedRegions '$outFileSortedRegions'
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
45 #end if
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
46 #end if
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
47
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
48 #if $mode.mode_select == "reference-point":
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
49 --referencePoint $mode.referencePoint
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
50 $mode.nanAfterEnd
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
51 --beforeRegionStartLength $mode.beforeRegionStartLength
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
52 --afterRegionStartLength $mode.afterRegionStartLength
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
53 #else
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
54 --regionBodyLength $mode.regionBodyLength
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
55 --startLabel "$mode.startLabel"
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
56 --endLabel "$mode.endLabel"
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
57 #if $mode.regionStartLength.regionStartLength_select == "yes":
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
58 --beforeRegionStartLength $mode.regionStartLength.beforeRegionStartLength
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
59 --afterRegionStartLength $mode.regionStartLength.afterRegionStartLength
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
60 #end if
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
61 #end if
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
62
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
63 #if $advancedOpt.showAdvancedOpt == "yes":
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
64 --sortRegions '$advancedOpt.sortRegions'
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
65 --sortUsing '$advancedOpt.sortUsing'
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
66 --averageTypeBins '$advancedOpt.averageTypeBins'
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
67 $advancedOpt.missingDataAsZero
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
68 $advancedOpt.skipZeros
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
69 --binSize $advancedOpt.binSize
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
70
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
71 #if $advancedOpt.minThreshold:
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
72 --minThreshold $advancedOpt.minThreshold
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
73 #end if
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
74 #if $advancedOpt.maxThreshold:
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
75 --maxThreshold $advancedOpt.maxThreshold
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
76 #end if
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
77 #if $advancedOpt.scale:
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
78 --scale $advancedOpt.scale
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
79 #end if
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
80
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
81 #end if
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
82 ; rm $temp_input_path
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
83
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
84 </command>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
85 <inputs>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
86
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
87 <repeat name="regionsFiles" title="regions to plot" min="1">
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
88 <param name="regionsFile" format="bed" type="data" label="Regions to plot" help="File, in BED format, containing the regions to plot."/>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
89 <param name="label" type="text" size="30" optional="true" value="" label="Label" help="Label to use in the output."/>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
90 </repeat>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
91
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
92 <param name="scoreFile" format="bigwig" type="data" label="Score file" help="Should be a bigWig file (containing a score, usually covering the whole genome). You can generate a bigWig file either from a bedGraph or WIG file using UCSC tools or from a BAM file using the deepTool bamCoverage."/>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
93
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
94 <conditional name="mode" >
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
95 <param name="mode_select" type="select" label="computeMatrix has two main output options" help="In the scale-regions mode, all regions in the BED file are stretched or shrunk to the same length (bp) that is indicated by the user. Reference-point refers to a position within the BED regions (e.g start of region). In the reference-point mode only those genomic positions before (downstream) and/or after (upstream) the reference point will be plotted.">
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
96 <option value="scale-regions" selected="true">scale-regions</option>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
97 <option value="reference-point">reference-point</option>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
98 </param>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
99
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
100 <when value="scale-regions" >
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
101 <param name="regionBodyLength" type="integer" value="500" label="Distance in bp to which all regions are going to be fitted"/>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
102 <param name="startLabel" type="text" value="TSS" size="10" label="Label for the region start" help ="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;." />
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
103 <param name="endLabel" type="text" value="TES" size="10" label="Label for the region end" help="Label shown in the plot for the region end. Default is TES (transcription end site)."/>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
104 <conditional name="regionStartLength">
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
105 <param name="regionStartLength_select" type="select" label="Set distance up- and downstream of the given regions">
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
106 <option value="no" selected="true">no</option>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
107 <option value="yes">yes</option>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
108 </param>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
109 <when value="no" />
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
110 <when value="yes">
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
111 <param name="beforeRegionStartLength" type="integer" value="1000" min="1" optional="true" label="Distance upstream of the start site of the regions defined in the region file" help="If the regions are genes, this would be the distance upstream of the transcription start site."/>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
112 <param name="afterRegionStartLength" type="integer" value="1000" min="1" optional="true" label="Distance downstream of the end site of the given regions" help="If the regions are genes, this would be the distance downstream of the transcription end site."/>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
113 </when>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
114 </conditional>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
115 </when>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
116
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
117 <when value="reference-point">
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
118 <param name="referencePoint" type="select" label="The reference point for the plotting">
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
119 <option value="TSS" selected="true">beginning of region (e.g. TSS)</option>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
120 <option value="TES">end of region (e.g. TES)</option>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
121 <option value="center">center of region</option>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
122 </param>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
123 <param name="nanAfterEnd" type="boolean" truevalue="--nanAfterEnd" falsevalue="" label="Discard any values after the region end" help="This is useful to visualize the region end when not using the scale-regions mode and when the reference-point is set to the TSS."/>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
124 <param name="beforeRegionStartLength" type="integer" value="1000" min="1" label="Distance upstream of the start site of the regions defined in the region file" help="If the regions are genes, this would be the distance upstream of the transcription start site."/>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
125 <param name="afterRegionStartLength" type="integer" value="1000" min="1" label="Distance downstream of the end site of the given regions" help="If the regions are genes, this would be the distance downstream of the transcription end site."/>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
126 </when>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
127 </conditional>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
128
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
129 <expand macro="input_graphic_output_settings">
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
130 <expand macro="input_save_matrix_values" />
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
131 </expand>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
132
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
133 <conditional name="advancedOpt" >
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
134 <param name="showAdvancedOpt" type="select" label="Show advanced options" >
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
135 <option value="no" selected="true">no</option>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
136 <option value="yes">yes</option>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
137 </param>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
138 <when value="no" />
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
139 <when value="yes">
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
140 <param name="binSize" type="integer" value="100" min="1" optional="true" label="Length, in base pairs, of the non-overlapping bin for averaging the score over the regions length" />
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
141 <param name="sortRegions" type="select" label="Sort regions"
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
142 help="Whether the output file should present the regions sorted.">
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
143 <option value="no" selected="true">no ordering</option>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
144 <option value="descend">descending order</option>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
145 <option value="ascend">ascending order</option>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
146 </param>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
147
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
148 <param name="sortUsing" type="select" label="Method used for sorting." help="The value is computed for each row." >
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
149 <option value="mean" selected="true">mean</option>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
150 <option value="median">median</option>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
151 <option value="min">min</option>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
152 <option value="max">max</option>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
153 <option value="sum">sum</option>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
154 <option value="region_length">region length</option>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
155 </param>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
156
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
157 <param name="averageTypeBins" type="select" label="Define the type of statistic that should be displayed." help="The value is computed for each bin.">
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
158 <option value="mean" selected="true">mean</option>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
159 <option value="median">median</option>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
160 <option value="min">min</option>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
161 <option value="max">max</option>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
162 <option value="sum">sum</option>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
163 <option value="std">std</option>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
164 </param>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
165
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
166 <param name="missingDataAsZero" type="boolean" truevalue="--missingDataAsZero" falsevalue="" label="Indicate missing data as zero" help="Set to &quot;yes&quot;, if missing data should be indicated as zeros. Default is to ignore such cases which will be depicted as black areas in the heatmap. (see &quot;Missing data color&quot; options of the heatmapper for additional options)."/>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
167 <param name="skipZeros" type="boolean" truevalue="--skipZeros" falsevalue="" label="Skip zeros" help="Whether regions with only scores of zero should be included or not. Default is to include them."/>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
168 <param name="minThreshold" type="float" optional="true" label="Minimum threshold" help="Any region containing a value that is equal or less than this numeric value will be skipped. This is useful to skip, for example, genes where the read count is zero for any of the bins. This could be the result of unmappable areas and can bias the overall results."/>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
169 <param name="maxThreshold" type="float" optional="true" label="Maximum threshold" help="Any region containing a value that is equal or higher that this numeric value will be skipped. The max threshold is useful to skip those few regions with very high read counts (e.g. major satellites) that may bias the average values."/>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
170 <param name="scale" type="float" optional="true" label="Scale" help="If set, all values are multiplied by this number."/>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
171 </when>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
172 </conditional>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
173
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
174 </inputs>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
175 <outputs>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
176 <data format="bgzip" name="outFileName" label="${tool.name} on ${on_string}: Matrix" />
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
177 <expand macro="output_graphic_outputs" />
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
178 <expand macro="output_save_matrix_values" />
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
179 </outputs>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
180 <!--
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
181 computeMatrix -S test.bw -R test2.bed -a 100 -b 100 -bs 1
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
182 -->
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
183 <tests>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
184 <test>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
185 <param name="regionsFile" value="test2.bed" ftype="bed" />
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
186 <param name="scoreFile" value="test.bw" ftype="bigwig" />
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
187 <param name="advancedOpt.binSize" value="1" />
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
188 <param name="mode.beforeRegionStartLength" value="100" />
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
189 <param name="mode.afterRegionStartLength" value="100" />
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
190 <output name="outFileName" file="master.mat.gz" ftype="bgzip" compare="sim_size" delta="100" />
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
191 </test>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
192 </tests>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
193 <help>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
194
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
195 **What it does**
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
196
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
197 This tool prepares an intermediary file (a gzipped table of values)
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
198 that contains scores associated with genomic regions that can be used
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
199 afterwards to plot a heatmap or a profile.
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
200
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
201 Genomic regions can really be anything - genes, parts of genes, ChIP-seq
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
202 peaks, favorite genome regions... as long as you provide a proper file
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
203 in BED or INTERVAL format. If you would like to compare different groups of regions
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
204 (i.e. genes from chromosome 2 and 3), you can supply more than 1 BED file, one for each group.
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
205
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
206 computeMatrix can also be used to filter and sort
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
207 regions according to their score by making use of its advanced output options.
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
208
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
209
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
210 .. image:: $PATH_TO_IMAGES/flowChart_computeMatrixetc.png
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
211 :alt: Relationship between computeMatrix, heatmapper and profiler
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
212
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
213
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
214 You can find more details on the computeMatrix wiki page: https://github.com/fidelram/deepTools/wiki/Visualizations#wiki-computeMatrix
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
215
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
216
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
217 -----
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
218
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
219 @REFERENCES@
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
220
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
221 </help>
29
3a2aab18a217 Uploaded
bgruening
parents: 28
diff changeset
222 <expand macro="citations" />
26
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
223 </tool>