comparison computeMatrix.xml @ 65:9bee2c86eeb1 draft

planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit ab1ab06323702186cf0c883d5774720cbb822cb5-dirty
author iuc
date Mon, 25 May 2015 05:16:10 -0400
parents f3140d17939e
children 1dbd76a58d8b
comparison
equal deleted inserted replaced
64:627004611e98 65:9bee2c86eeb1
1 <tool id="deeptools_computeMatrix" name="computeMatrix" version="@WRAPPER_VERSION@.0"> 1 <tool id="deeptools_computeMatrix" name="computeMatrix" version="@WRAPPER_VERSION@.0">
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> 2 <description>preparation step to plot a heatmap or a profile</description>
3 <expand macro="requirements" />
4 <expand macro="stdio" />
5 <macros> 3 <macros>
6 <token name="@BINARY@">computeMatrix</token> 4 <token name="@BINARY@">computeMatrix</token>
7 <import>deepTools_macros.xml</import> 5 <import>deepTools_macros.xml</import>
8 </macros> 6 </macros>
7 <expand macro="requirements" />
9 <command> 8 <command>
10 <![CDATA[ 9 <![CDATA[
11 #import tempfile 10 #import tempfile
12 11
13 #set $temp_input_handle = tempfile.NamedTemporaryFile()
14 #set $temp_input_path = $temp_input_handle.name
15 #silent $temp_input_handle.close()
16
17 #for $rf in $regionsFiles: 12 #for $rf in $regionsFiles:
18 cat "$rf.regionsFile" >> $temp_input_path; 13 cat "$rf.regionsFile" >> ./temp_input_path;
19 #if str($rf.label.value).strip(): 14 #if str($rf.label.value).strip():
20 echo "\#$rf.label.value" >> $temp_input_path; 15 echo "\#$rf.label.value" >> ./temp_input_path;
21 #else: 16 #else:
22 echo "\#$rf.regionsFile.name" >> $temp_input_path; 17 echo "\#$rf.regionsFile.name" >> ./temp_input_path;
23 #end if 18 #end if
24 #end for 19 #end for
25 20
26 computeMatrix 21 computeMatrix
27 22
28 $mode.mode_select 23 $mode.mode_select
29 --regionsFileName '$temp_input_path' 24 --regionsFileName ./temp_input_path
30 --scoreFileName '$scoreFile' 25 --scoreFileName '$scoreFile'
31 --outFileName '$outFileName' 26 --outFileName '$outFileName'
32 27
33 @THREADS@ 28 @THREADS@
34 29
77 #if $advancedOpt.scale: 72 #if $advancedOpt.scale:
78 --scale $advancedOpt.scale 73 --scale $advancedOpt.scale
79 #end if 74 #end if
80 75
81 #end if 76 #end if
82 ; rm $temp_input_path
83 ]]> 77 ]]>
84 </command> 78 </command>
85 <inputs> 79 <inputs>
86 80
87 <repeat name="regionsFiles" title="regions to plot" min="1"> 81 <repeat name="regionsFiles" title="regions to plot" min="1">
88 <param name="regionsFile" format="bed" type="data" label="Regions to plot" help="File, in BED format, containing the regions to plot."/> 82 <param name="regionsFile" format="bed" type="data" label="Regions to plot"
89 <param name="label" type="text" size="30" optional="true" value="" label="Label" help="Label to use in the output."/> 83 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."/>
90 </repeat> 86 </repeat>
91 87
92 <param name="scoreFile" format="bigwig" type="data" 88 <param name="scoreFile" format="bigwig" type="data"
93 label="Score file" 89 label="Score file"
94 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. (-scoreFile)"/> 90 help="Should be a bigWig file (containing a score, usually covering
91 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
93 deepTool bamCoverage. (-scoreFile)"/>
95 94
96 <conditional name="mode" > 95 <conditional name="mode" >
97 <param name="mode_select" type="select" 96 <param name="mode_select" type="select"
98 label="computeMatrix has two main output options" 97 label="computeMatrix has two main output options"
99 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."> 98 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
100 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
102 those genomic positions before (downstream) and/or after (upstream)
103 the reference point will be plotted.">
100 <option value="scale-regions" selected="true">scale-regions</option> 104 <option value="scale-regions" selected="true">scale-regions</option>
101 <option value="reference-point">reference-point</option> 105 <option value="reference-point">reference-point</option>
102 </param> 106 </param>
103 107
104 <when value="scale-regions" > 108 <when value="scale-regions" >
105 <param name="regionBodyLength" type="integer" value="500" 109 <param name="regionBodyLength" type="integer" value="500"
106 label="Distance in bp to which all regions are going to be fitted" help="(--regionBodyLength)"/> 110 label="Distance in bp to which all regions are going to be fitted" help="(--regionBodyLength)"/>
107 <param name="startLabel" type="text" value="TSS" size="10" 111 <param name="startLabel" type="text" value="TSS" size="10"
108 label="Label for the region start" 112 label="Label for the region start"
109 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;. (--startLabel)" /> 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. &quot;peak start&quot;. (--startLabel)" />
110 <param name="endLabel" type="text" value="TES" size="10" 116 <param name="endLabel" type="text" value="TES" size="10"
111 label="Label for the region end" 117 label="Label for the region end"
112 help="Label shown in the plot for the region end. Default is TES (transcription end site). (--endLabel)"/> 118 help="Label shown in the plot for the region end. Default is TES (transcription end site). (--endLabel)"/>
113 <conditional name="regionStartLength"> 119 <conditional name="regionStartLength">
114 <param name="regionStartLength_select" type="select" label="Set distance up- and downstream of the given regions"> 120 <param name="regionStartLength_select" type="select" label="Set distance up- and downstream of the given regions">
117 </param> 123 </param>
118 <when value="no" /> 124 <when value="no" />
119 <when value="yes"> 125 <when value="yes">
120 <param name="beforeRegionStartLength" type="integer" value="1000" min="1" 126 <param name="beforeRegionStartLength" type="integer" value="1000" min="1"
121 label="Distance upstream of the start site of the regions defined in the region file" 127 label="Distance upstream of the start site of the regions defined in the region file"
122 help="If the regions are genes, this would be the distance upstream of the transcription start site. (--beforeRegionStartLength)"/> 128 help="If the regions are genes, this would be the
129 distance upstream of the transcription start site. (--beforeRegionStartLength)"/>
123 <param name="afterRegionStartLength" type="integer" value="1000" min="1" 130 <param name="afterRegionStartLength" type="integer" value="1000" min="1"
124 label="Distance downstream of the end site of the given regions" 131 label="Distance downstream of the end site of the given regions"
125 help="If the regions are genes, this would be the distance downstream of the transcription end site. (--afterRegionStartLength)"/> 132 help="If the regions are genes, this would be the
133 distance downstream of the transcription end site. (--afterRegionStartLength)"/>
126 </when> 134 </when>
127 </conditional> 135 </conditional>
128 </when> 136 </when>
129 <when value="reference-point"> 137 <when value="reference-point">
130 <param name="referencePoint" type="select" label="The reference point for the plotting"> 138 <param name="referencePoint" type="select" label="The reference point for the plotting">
132 <option value="TES">end of region (e.g. TES)</option> 140 <option value="TES">end of region (e.g. TES)</option>
133 <option value="center">center of region</option> 141 <option value="center">center of region</option>
134 </param> 142 </param>
135 <param name="nanAfterEnd" type="boolean" truevalue="--nanAfterEnd" falsevalue="" 143 <param name="nanAfterEnd" type="boolean" truevalue="--nanAfterEnd" falsevalue=""
136 label="Discard any values after the region end" 144 label="Discard any values after the region end"
137 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. (--nanAfterEnd)"/> 145 help="This is useful to visualize the region end when not using the
146 scale-regions mode and when the reference-point is set to the TSS. (--nanAfterEnd)"/>
138 <param name="beforeRegionStartLength" type="integer" value="1000" min="1" 147 <param name="beforeRegionStartLength" type="integer" value="1000" min="1"
139 label="Distance upstream of the start site of the regions defined in the region file" 148 label="Distance upstream of the start site of the regions defined in the region file"
140 help="If the regions are genes, this would be the distance upstream of the transcription start site. (--beforeRegionStartLength)"/> 149 help="If the regions are genes, this would be the distance upstream of the transcription start site. (--beforeRegionStartLength)"/>
141 <param name="afterRegionStartLength" type="integer" value="1000" min="1" 150 <param name="afterRegionStartLength" type="integer" value="1000" min="1"
142 label="Distance downstream of the end site of the given regions" 151 label="Distance downstream of the end site of the given regions"
186 <option value="std">std</option> 195 <option value="std">std</option>
187 </param> 196 </param>
188 197
189 <param name="missingDataAsZero" type="boolean" truevalue="--missingDataAsZero" falsevalue="" 198 <param name="missingDataAsZero" type="boolean" truevalue="--missingDataAsZero" falsevalue=""
190 label="Indicate missing data as zero" 199 label="Indicate missing data as zero"
191 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). (--missingDataAsZero)"/> 200 help="Set to &quot;yes&quot;, if missing data should be indicated as zeros.
201 Default is to ignore such cases which will be depicted as black areas in the
202 heatmap. (see &quot;Missing data color&quot; options of the heatmapper for additional options).
203 (--missingDataAsZero)"/>
192 <param name="skipZeros" type="boolean" truevalue="--skipZeros" falsevalue="" 204 <param name="skipZeros" type="boolean" truevalue="--skipZeros" falsevalue=""
193 label="Skip zeros" 205 label="Skip zeros"
194 help="Whether regions with only scores of zero should be included or not. Default is to include them. (--skipZeros)"/> 206 help="Whether regions with only scores of zero should be included or not.
207 Default is to include them. (--skipZeros)"/>
195 <param name="minThreshold" type="float" optional="True" 208 <param name="minThreshold" type="float" optional="True"
196 label="Minimum threshold" 209 label="Minimum threshold"
197 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. (--minThreshold)"/> 210 help="Any region containing a value that is equal or less than this numeric
211 value will be skipped. This is useful to skip, for example, genes where the
212 read count is zero for any of the bins. This could be the result of
213 unmappable areas and can bias the overall results. (--minThreshold)"/>
198 <param name="maxThreshold" type="float" optional="True" 214 <param name="maxThreshold" type="float" optional="True"
199 label="Maximum threshold" 215 label="Maximum threshold"
200 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. (--maxThreshold)"/> 216 help="Any region containing a value that is equal or higher that this
217 numeric value will be skipped. The max threshold is useful to skip those
218 few regions with very high read counts (e.g. major satellites) that may
219 bias the average values. (--maxThreshold)"/>
201 <param name="scale" type="float" optional="True" label="Scaling factor" 220 <param name="scale" type="float" optional="True" label="Scaling factor"
202 help="If set, all values are multiplied by this number. (--scale)"/> 221 help="If set, all values are multiplied by this number. (--scale)"/>
203 </when> 222 </when>
204 </conditional> 223 </conditional>
205 </inputs> 224 </inputs>
206 <outputs> 225 <outputs>
207 <data format="bgzip" name="outFileName" label="${tool.name} on ${on_string}: Matrix" /> 226 <data format="deeptools_matrix" name="outFileName" label="${tool.name} on ${on_string}: Matrix" />
208 <expand macro="output_graphic_outputs" /> 227 <expand macro="output_graphic_outputs" />
209 <expand macro="output_save_matrix_values" /> 228 <expand macro="output_save_matrix_values" />
210 </outputs> 229 </outputs>
211 <!-- 230 <!--
212 computeMatrix -S test.bw -R test2.bed -a 100 -b 100 -bs 1 231 computeMatrix -S test.bw -R test2.bed -a 100 -b 100 -bs 1
221 <param name="sortUsing" value="sum" /> 240 <param name="sortUsing" value="sum" />
222 <param name="averageTypeBins" value="sum" /> 241 <param name="averageTypeBins" value="sum" />
223 <param name="missingDataAsZero" value="True" /> 242 <param name="missingDataAsZero" value="True" />
224 <param name="beforeRegionStartLength" value="10" /> 243 <param name="beforeRegionStartLength" value="10" />
225 <param name="afterRegionStartLength" value="10" /> 244 <param name="afterRegionStartLength" value="10" />
226 <output name="outFileName" file="computeMatrix_result1.gz" ftype="bgzip" compare="sim_size" /> 245 <output name="outFileName" file="computeMatrix_result1.gz" ftype="deeptools_matrix" compare="sim_size" />
227 </test> 246 </test>
228 <test> 247 <test>
229 <param name="regionsFile" value="computeMatrix2.bed" ftype="bed" /> 248 <param name="regionsFile" value="computeMatrix2.bed" ftype="bed" />
230 <param name="scoreFile" value="computeMatrix2.bw" ftype="bigwig" /> 249 <param name="scoreFile" value="computeMatrix2.bw" ftype="bigwig" />
231 <param name="showAdvancedOpt" value="yes" /> 250 <param name="showAdvancedOpt" value="yes" />
232 <param name="mode_select" value="reference-point" /> 251 <param name="mode_select" value="reference-point" />
233 <param name="binSize" value="10" /> 252 <param name="binSize" value="10" />
234 <param name="beforeRegionStartLength" value="10" /> 253 <param name="beforeRegionStartLength" value="10" />
235 <param name="afterRegionStartLength" value="10" /> 254 <param name="afterRegionStartLength" value="10" />
236 <output name="outFileName" file="computeMatrix_result2.gz" ftype="bgzip" compare="sim_size" /> 255 <output name="outFileName" file="computeMatrix_result2.gz" ftype="deeptools_matrix" compare="sim_size" />
237 </test> 256 </test>
238 </tests> 257 </tests>
239 <help> 258 <help>
240 <![CDATA[ 259 <![CDATA[
241 **What it does** 260 **What it does**