Mercurial > repos > bgruening > deeptools_compute_matrix
comparison computeMatrix.xml @ 7:021729469baf draft
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit ae00542731230245927953207977833a0f020b69
author | bgruening |
---|---|
date | Wed, 23 Dec 2015 07:34:34 -0500 |
parents | 451e73bf38fe |
children | e3f4303309cc |
comparison
equal
deleted
inserted
replaced
6:451e73bf38fe | 7:021729469baf |
---|---|
1 <tool id="deeptools_compute_matrix" name="computeMatrix" version="@WRAPPER_VERSION@.0"> | 1 <tool id="deeptools_compute_matrix" name="computeMatrix" version="@WRAPPER_VERSION@.0"> |
2 <description>preparation step to plot a heatmap or a profile</description> | 2 <description>prepares data for plotting a heatmap or a profile of given regions</description> |
3 <macros> | 3 <macros> |
4 <token name="@BINARY@">computeMatrix</token> | 4 <token name="@BINARY@">computeMatrix</token> |
5 <import>deepTools_macros.xml</import> | 5 <import>deepTools_macros.xml</import> |
6 </macros> | 6 </macros> |
7 <expand macro="requirements" /> | 7 <expand macro="requirements" /> |
8 <command> | 8 <command> |
9 <![CDATA[ | 9 <![CDATA[ |
10 #import tempfile | 10 #import tempfile |
11 | 11 |
12 #for $rf in $regionsFiles: | |
13 cat "$rf.regionsFile" >> ./temp_input_path; | |
14 #if str($rf.label.value).strip(): | |
15 echo "\#$rf.label.value" >> ./temp_input_path; | |
16 #else: | |
17 echo "\#$rf.regionsFile.name" >> ./temp_input_path; | |
18 #end if | |
19 #end for | |
20 | |
21 @BINARY@ | 12 @BINARY@ |
22 | 13 |
23 $mode.mode_select | 14 $mode.mode_select |
24 --regionsFileName ./temp_input_path | 15 --regionsFileName |
25 --scoreFileName '$scoreFile' | 16 #for $rf in $regionsFiles: |
17 '$rf.regionsFile' | |
18 #end for | |
19 --scoreFileName | |
20 #for $bw in $scoreFileName: | |
21 '$bw' | |
22 #end for | |
26 --outFileName '$outFileName' | 23 --outFileName '$outFileName' |
27 | 24 |
28 @THREADS@ | 25 @THREADS@ |
29 | 26 |
30 #if $output.showOutputSettings == "yes" | 27 #if $output.showOutputSettings == "yes" |
31 #if $output.saveData: | |
32 --outFileNameData '$outFileNameData' | |
33 #end if | |
34 #if $output.saveMatrix: | 28 #if $output.saveMatrix: |
35 --outFileNameMatrix '$outFileNameMatrix' | 29 --outFileNameMatrix '$outFileNameMatrix' |
36 #end if | 30 #end if |
37 | 31 |
38 #if $output.saveSortedRegions: | 32 #if $output.saveSortedRegions: |
45 $mode.nanAfterEnd | 39 $mode.nanAfterEnd |
46 --beforeRegionStartLength $mode.beforeRegionStartLength | 40 --beforeRegionStartLength $mode.beforeRegionStartLength |
47 --afterRegionStartLength $mode.afterRegionStartLength | 41 --afterRegionStartLength $mode.afterRegionStartLength |
48 #else | 42 #else |
49 --regionBodyLength $mode.regionBodyLength | 43 --regionBodyLength $mode.regionBodyLength |
50 --startLabel "$mode.startLabel" | |
51 --endLabel "$mode.endLabel" | |
52 #if $mode.regionStartLength.regionStartLength_select == "yes": | 44 #if $mode.regionStartLength.regionStartLength_select == "yes": |
53 --beforeRegionStartLength $mode.regionStartLength.beforeRegionStartLength | 45 --beforeRegionStartLength $mode.regionStartLength.beforeRegionStartLength |
54 --afterRegionStartLength $mode.regionStartLength.afterRegionStartLength | 46 --afterRegionStartLength $mode.regionStartLength.afterRegionStartLength |
55 #end if | 47 #end if |
56 #end if | 48 #end if |
76 #end if | 68 #end if |
77 ]]> | 69 ]]> |
78 </command> | 70 </command> |
79 <inputs> | 71 <inputs> |
80 | 72 |
81 <repeat name="regionsFiles" title="regions to plot" min="1"> | 73 <repeat name="regionsFiles" title="Select regions" min="1"> |
82 <param name="regionsFile" format="bed" type="data" label="Regions to plot" | 74 <param name="regionsFile" format="bed" type="data" label="Regions to plot" |
83 help="File, in BED format, containing the regions to plot."/> | 75 help="File, in BED format, containing the regions to plot."/> |
84 <param name="label" type="text" size="30" optional="true" value="" label="Label" | |
85 help="Label to use in the output."/> | |
86 </repeat> | 76 </repeat> |
87 | 77 |
88 <param name="scoreFile" format="bigwig" type="data" | 78 <param name="scoreFileName" format="bigwig" type="data" |
89 label="Score file" | 79 label="Score file" multiple="True" |
90 help="Should be a bigWig file (containing a score, usually covering | 80 help="Should be a bigWig file (containing a score, usually covering |
91 the whole genome). You can generate a bigWig file either from a | 81 the whole genome). You can generate a bigWig file either from a |
92 bedGraph or WIG file using UCSC tools or from a BAM file using the | 82 bedGraph or WIG file using UCSC tools or from a BAM file using the |
93 deepTool bamCoverage. (-scoreFile)"/> | 83 deepTool bamCoverage. (--scoreFileName)"/> |
94 | 84 |
95 <conditional name="mode" > | 85 <conditional name="mode" > |
96 <param name="mode_select" type="select" | 86 <param name="mode_select" type="select" |
97 label="computeMatrix has two main output options" | 87 label="computeMatrix has two main output options" |
98 help="In the scale-regions mode, all regions in the BED file are | 88 help="In the scale-regions mode, all regions in the BED file are |
99 stretched or shrunk to the same length (bp) that is indicated | 89 stretched or shrunk to the same length (bp) that is indicated |
100 by the user. Reference-point refers to a position within the BED | 90 by the user. Reference-point refers to a position within the BED |
101 regions (e.g start of region). In the reference-point mode only | 91 regions (e.g start of region). In the reference-point mode only |
102 those genomic positions before (downstream) and/or after (upstream) | 92 those genomic positions before (downstream) and/or after (upstream) |
103 the reference point will be plotted."> | 93 the reference point will be considered."> |
104 <option value="scale-regions" selected="true">scale-regions</option> | 94 <option value="scale-regions" selected="true">scale-regions</option> |
105 <option value="reference-point">reference-point</option> | 95 <option value="reference-point">reference-point</option> |
106 </param> | 96 </param> |
107 | 97 |
108 <when value="scale-regions" > | 98 <when value="scale-regions" > |
109 <param argument="--regionBodyLength" type="integer" value="500" | 99 <param argument="--regionBodyLength" type="integer" value="500" |
110 label="Distance in bp to which all regions are going to be fitted" help=""/> | 100 label="Distance in bp to which all regions are going to be fitted" help=""/> |
111 <param argument="--startLabel" type="text" value="TSS" size="10" | |
112 label="Label for the region start" | |
113 help ="Label shown in the plot for the start of the region. | |
114 Default is TSS (transcription start site), but could be changed to anything, | |
115 e.g. "peak start"." /> | |
116 <param argument="--endLabel" type="text" value="TES" size="10" | |
117 label="Label for the region end" | |
118 help="Label shown in the plot for the region end. Default is TES (transcription end site)."/> | |
119 <conditional name="regionStartLength"> | 101 <conditional name="regionStartLength"> |
120 <param name="regionStartLength_select" type="select" label="Set distance up- and downstream of the given regions"> | 102 <param name="regionStartLength_select" type="select" label="Set distance up- and downstream of the given regions"> |
121 <option value="no" selected="true">no</option> | 103 <option value="no" selected="true">no</option> |
122 <option value="yes">yes</option> | 104 <option value="yes">yes</option> |
123 </param> | 105 </param> |
184 | 166 |
185 <param name="missingDataAsZero" type="boolean" truevalue="--missingDataAsZero" falsevalue="" checked="False" | 167 <param name="missingDataAsZero" type="boolean" truevalue="--missingDataAsZero" falsevalue="" checked="False" |
186 label="Convert missing values to 0?." | 168 label="Convert missing values to 0?." |
187 help="If set to 'yes', missing values (NAs) are converted to 0. | 169 help="If set to 'yes', missing values (NAs) are converted to 0. |
188 The default is to ignore such cases, which will be | 170 The default is to ignore such cases, which will be |
189 depicted as black areas in the heatmap by default." /> | 171 depicted as black areas once a heatmap is created." /> |
190 | 172 |
191 <expand macro="skipZeros" /> | 173 <expand macro="skipZeros" /> |
192 <expand macro="skipNAs" /> | 174 <expand macro="skipNAs" /> |
193 | 175 |
194 <param name="minThreshold" type="float" optional="True" | 176 <param name="minThreshold" type="float" optional="True" |
212 <data format="deeptools_compute_matrix_archive" name="outFileName" label="${tool.name} on ${on_string}: Matrix" /> | 194 <data format="deeptools_compute_matrix_archive" name="outFileName" label="${tool.name} on ${on_string}: Matrix" /> |
213 <expand macro="output_graphic_outputs" /> | 195 <expand macro="output_graphic_outputs" /> |
214 <expand macro="output_save_matrix_values" /> | 196 <expand macro="output_save_matrix_values" /> |
215 </outputs> | 197 </outputs> |
216 <!-- | 198 <!-- |
217 computeMatrix -S test.bw -R test2.bed -a 100 -b 100 -bs 1 | 199 computeMatrix -S test.bw -R test2.bed -a 100 -b 100 -bs 1 |
218 --> | 200 --> |
219 <tests> | 201 <tests> |
220 <test> | 202 <test> |
221 <param name="regionsFile" value="computeMatrix1.bed" ftype="bed" /> | 203 <param name="regionsFile" value="computeMatrix1.bed" ftype="bed" /> |
222 <param name="scoreFile" value="bamCoverage_result4.bw" ftype="bigwig" /> | 204 <param name="scoreFileName" value="bamCoverage_result4.bw" ftype="bigwig" /> |
223 <param name="showAdvancedOpt" value="yes" /> | 205 <param name="showAdvancedOpt" value="yes" /> |
224 <param name="mode_select" value="reference-point" /> | 206 <param name="mode_select" value="reference-point" /> |
225 <param name="binSize" value="10" /> | 207 <param name="binSize" value="10" /> |
226 <param name="sortUsing" value="sum" /> | 208 <param name="sortUsing" value="sum" /> |
227 <param name="averageTypeBins" value="sum" /> | 209 <param name="averageTypeBins" value="sum" /> |
230 <param name="afterRegionStartLength" value="10" /> | 212 <param name="afterRegionStartLength" value="10" /> |
231 <output name="outFileName" file="computeMatrix_result1.gz" ftype="deeptools_compute_matrix_archive" compare="sim_size" /> | 213 <output name="outFileName" file="computeMatrix_result1.gz" ftype="deeptools_compute_matrix_archive" compare="sim_size" /> |
232 </test> | 214 </test> |
233 <test> | 215 <test> |
234 <param name="regionsFile" value="computeMatrix2.bed" ftype="bed" /> | 216 <param name="regionsFile" value="computeMatrix2.bed" ftype="bed" /> |
235 <param name="scoreFile" value="computeMatrix2.bw" ftype="bigwig" /> | 217 <param name="scoreFileName" value="computeMatrix2.bw" ftype="bigwig" /> |
236 <param name="showAdvancedOpt" value="yes" /> | 218 <param name="showAdvancedOpt" value="yes" /> |
237 <param name="mode_select" value="reference-point" /> | 219 <param name="mode_select" value="reference-point" /> |
238 <param name="binSize" value="10" /> | 220 <param name="binSize" value="10" /> |
239 <param name="beforeRegionStartLength" value="10" /> | 221 <param name="beforeRegionStartLength" value="10" /> |
240 <param name="afterRegionStartLength" value="10" /> | 222 <param name="afterRegionStartLength" value="10" /> |
241 <output name="outFileName" file="computeMatrix_result2.gz" ftype="deeptools_compute_matrix_archive" compare="sim_size" /> | 223 <output name="outFileName" file="computeMatrix_result2.gz" ftype="deeptools_compute_matrix_archive" compare="sim_size" /> |
242 </test> | 224 </test> |
243 <test> | 225 <test> |
244 <param name="regionsFile" value="computeMatrix2.bed" ftype="bed" /> | 226 <param name="regionsFile" value="computeMatrix2.bed" ftype="bed" /> |
245 <param name="scoreFile" value="computeMatrix2.bw" ftype="bigwig" /> | 227 <param name="scoreFileName" value="computeMatrix2.bw" ftype="bigwig" /> |
246 <param name="showAdvancedOpt" value="yes" /> | 228 <param name="showAdvancedOpt" value="yes" /> |
247 <param name="mode_select" value="scale-regions" /> | 229 <param name="mode_select" value="scale-regions" /> |
248 <param name="endLabel" value="END" /> | 230 <param name="endLabel" value="END" /> |
249 <param name="regionStartLength" value="yes" /> | 231 <param name="regionStartLength" value="yes" /> |
250 <output name="outFileName" file="computeMatrix_result3.gz" ftype="deeptools_compute_matrix_archive" compare="sim_size" /> | 232 <output name="outFileName" file="computeMatrix_result3.gz" ftype="deeptools_compute_matrix_archive" compare="sim_size" /> |
269 | 251 |
270 .. image:: $PATH_TO_IMAGES/flowChart_computeMatrixetc.png | 252 .. image:: $PATH_TO_IMAGES/flowChart_computeMatrixetc.png |
271 :alt: Relationship between computeMatrix, heatmapper and profiler | 253 :alt: Relationship between computeMatrix, heatmapper and profiler |
272 | 254 |
273 | 255 |
274 You can find more details on the computeMatrix wiki page: https://github.com/fidelram/deepTools/wiki/Visualizations#wiki-computeMatrix | 256 You can find more details on the computeMatrix doc page: https://deeptools.readthedocs.org/en/release-1.6/content/tools/computeMatrix.html |
275 | 257 |
276 | 258 |
277 ----- | 259 ----- |
278 | 260 |
279 @REFERENCES@ | 261 @REFERENCES@ |