comparison bamCorrelate.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
comparison
equal deleted inserted replaced
64:627004611e98 65:9bee2c86eeb1
1 <tool id="deeptools_bamCorrelate" name="bamCorrelate" version="@WRAPPER_VERSION@.0"> 1 <tool id="deeptools_bamCorrelate" name="bamCorrelate" version="@WRAPPER_VERSION@.0">
2 <description>correlates pairs of BAM files</description> 2 <description>correlates pairs of BAM files</description>
3 <expand macro="requirements" />
4 <expand macro="stdio" />
5 <macros> 3 <macros>
6 <token name="@BINARY@">bamCorrelate</token> 4 <token name="@BINARY@">bamCorrelate</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 #set files=[] 10 #set files=[]
12 #set labels=[] 11 #set labels=[]
13 12
17 16
18 $mode.modeOpt 17 $mode.modeOpt
19 18
20 @THREADS@ 19 @THREADS@
21 20
22 --bamfiles #echo " ".join($files) 21 --bamfiles '#echo "' '".join($files)#'
23 --labels #echo " ".join($labels) 22 --labels '#echo "' '".join($labels)#'
24 --fragmentLength $fragmentLength 23 --fragmentLength $fragmentLength
25 --corMethod $corMethod 24 --corMethod $corMethod
26 25
27 --plotFile $outFileName 26 --plotFile $outFileName
28 27
29 #if $output.showOutputSettings == "yes" 28 #if $output.showOutputSettings == "yes"
30 --outRawCounts '$outFileRawCounts' 29 --outRawCounts '$outFileRawCounts'
31 --outFileCorMatrix '$outFileCorMatrix' 30 --outFileCorMatrix '$outFileCorMatrix'
32 --plotFileFormat $output.outFileFormat 31 --plotFileFormat '$output.outFileFormat'
33 #else: 32 #else:
34 --plotFileFormat 'png' 33 --plotFileFormat 'png'
35 #end if 34 #end if
36 35
37 #if $mode.modeOpt == "bins": 36 #if $mode.modeOpt == "bins":
38 --binSize '$mode.binSize' 37 --binSize '$mode.binSize'
39 --distanceBetweenBins '$mode.distanceBetweenBins' 38 --distanceBetweenBins '$mode.distanceBetweenBins'
40 $mode.doNotRemoveOutliers 39 $mode.doNotRemoveOutliers
41
42 #else: 40 #else:
43 --BED $mode.region_file 41 --BED $mode.region_file
44 #end if 42 #end if
45 43
46 #### options available in both modes 44 #### options available in both modes
47 #if str($mode.region.value) != '': 45 #if str($mode.region.value) != '':
48 --region '$mode.region' 46 --region '$mode.region'
49 #end if 47 #end if
50 48
49 #if $plotTitle and str($plotTitle).strip() != "":
50 --plotTitle '$plotTitle'
51 #end if
52 $plotNumbers
51 #if $mode.advancedOpt.showAdvancedOpt == "yes": 53 #if $mode.advancedOpt.showAdvancedOpt == "yes":
52 54
53 $mode.advancedOpt.doNotExtendPairedEnds 55 $mode.advancedOpt.doNotExtendPairedEnds
54 $mode.advancedOpt.ignoreDuplicates 56 $mode.advancedOpt.ignoreDuplicates
55 $mode.advancedOpt.includeZeros 57 $mode.advancedOpt.includeZeros
73 <inputs> 75 <inputs>
74 <expand macro="multiple_input_bams" /> 76 <expand macro="multiple_input_bams" />
75 77
76 <param name="fragmentLength" type="integer" value="200" min="1" 78 <param name="fragmentLength" type="integer" value="200" min="1"
77 label="Length of the average fragment size" 79 label="Length of the average fragment size"
78 help ="Reads will be extended to match this length unless they are paired-end, in which case they will be extended to match the fragment length. *NOTE*: If the BAM files contain mated and unmated paired-end reads, unmated reads will be extended to match the fragment length. (--fragmentLength)"/> 80 help ="Reads will be extended to match this length unless they are paired-end,
81 in which case they will be extended to match the fragment length.
82 *NOTE*: If the BAM files contain mated and unmated paired-end reads, unmated reads will
83 be extended to match the fragment length. (--fragmentLength)"/>
79 84
80 <param name="corMethod" type="select" label="Correlation method"> 85 <param name="corMethod" type="select" label="Correlation method">
81 <option value="spearman" selected="True">Spearman</option> 86 <option value="spearman" selected="True">Spearman</option>
82 <option value="pearson">Pearson</option> 87 <option value="pearson">Pearson</option>
83 </param> 88 </param>
84 89
85 <conditional name="mode"> 90 <conditional name="mode">
86 <param name="modeOpt" type="select" label="Choose computation mode" 91 <param name="modeOpt" type="select" label="Choose computation mode"
87 help="In the bins mode, the correlation is computed based on equal length bins. In the BED file mode, as list of genomic regions in BED format has to be given. For each region in the BED file the number of overlapping reads is counted in each of the BAM files. Then the correlation is computed."> 92 help="In the bins mode, the correlation is computed based on equal
93 length bins. In the BED file mode, as list of genomic regions in BED
94 format has to be given. For each region in the BED file the number of
95 overlapping reads is counted in each of the BAM files.
96 Then the correlation is computed.">
88 <option value="bins" selected="true">Bins</option> 97 <option value="bins" selected="true">Bins</option>
89 <option value="BED-file">Limit correlation to certain regions (BED file)</option> 98 <option value="BED-file">Limit correlation to certain regions (BED file)</option>
90 </param> 99 </param>
91 <when value="bins"> 100 <when value="bins">
92 <param name="binSize" type="integer" value="10000" min="1" 101 <param name="binSize" type="integer" value="10000" min="1"
93 label="Bin size in bp" 102 label="Bin size in bp"
94 help="Length in base pairs for a window used to sample the genome."/> 103 help="Length in base pairs for a window used to sample the genome. (--binSize)"/>
95 104
96 <param name="distanceBetweenBins" type="integer" value="0" min="0" 105 <param name="distanceBetweenBins" type="integer" value="0" min="0"
97 label="Distance between bins" 106 label="Distance between bins"
98 help="By default, bamCorrelate considers consecutive bins of 107 help="By default, bamCorrelate considers consecutive bins of
99 the specified 'Bin size'. However, to reduce the 108 the specified 'Bin size'. However, to reduce the
100 computation time, a larger distance between bins can 109 computation time, a larger distance between bins can
101 by given. Larger distances result in less bins being 110 by given. Larger distances result in less bins being
102 considered"/> 111 considered. (--distanceBetweenBins)"/>
103 112
104 <param name="doNotRemoveOutliers" type="boolean" 113 <param name="doNotRemoveOutliers" type="boolean"
105 truevalue="--doNotRemoveOutliers" falsevalue="" label="Do not filter outliers" 114 truevalue="--doNotRemoveOutliers" falsevalue="" label="Do not filter outliers"
106 help="By default, bins with very large counts are removed. 115 help="By default, bins with very large counts are removed.
107 By setting this option, outliers will not be 116 By setting this option, outliers will not be
111 removed the pearson correlation will wrongly report a 120 removed the pearson correlation will wrongly report a
112 very high correlation; that's why, by default, 121 very high correlation; that's why, by default,
113 bamCorrelate tries to remove outliers using 122 bamCorrelate tries to remove outliers using
114 the median absolute deviation (MAD) method applying a 123 the median absolute deviation (MAD) method applying a
115 threshold of 200 to only consider extremely large 124 threshold of 200 to only consider extremely large
116 deviations from the median."/> 125 deviations from the median. (--doNotRemoveOutliers)"/>
117 126
118 <expand macro="bamCorrelate_mode_actions" /> 127 <expand macro="bamCorrelate_mode_actions" />
119 </when> 128 </when>
120 <when value="BED-file"> 129 <when value="BED-file">
121 <param name="region_file" type="data" format="bed" 130 <param name="region_file" type="data" format="bed"
122 label="Region file in BED format" 131 label="Region file in BED format"
123 help="Correlation is computed for the number of reads that overlap such regions."/> 132 help="Correlation is computed for the number of reads that overlap such regions."/>
124 <expand macro="bamCorrelate_mode_actions" /> 133 <expand macro="bamCorrelate_mode_actions" />
125 </when> 134 </when>
126 </conditional> 135 </conditional>
127 136 <expand macro="plotTitle" />
137 <expand macro="plotNumbers" />
128 <conditional name="output"> 138 <conditional name="output">
129 <param name="showOutputSettings" type="select" label="Show advanced output settings" > 139 <param name="showOutputSettings" type="select" label="Show advanced output settings" >
130 <option value="no" selected="true">no</option> 140 <option value="no" selected="true">no</option>
131 <option value="yes">yes</option> 141 <option value="yes">yes</option>
132 </param> 142 </param>
160 </outputs> 170 </outputs>
161 <tests> 171 <tests>
162 <test> 172 <test>
163 <repeat name="input_files"> 173 <repeat name="input_files">
164 <param name="bamfile" value="bowtie2-test1.bam" ftype="bam" /> 174 <param name="bamfile" value="bowtie2-test1.bam" ftype="bam" />
175 <param name="label" value="first BAM file" />
165 </repeat> 176 </repeat>
166 <repeat name="input_files"> 177 <repeat name="input_files">
167 <param name="bamfile" value="bowtie2-test1.bam" ftype="bam" /> 178 <param name="bamfile" value="bowtie2-test1.bam" ftype="bam" />
179 <param name="label" value="second BAM file" />
168 </repeat> 180 </repeat>
169 <param name="modeOpt" value="bins" /> 181 <param name="modeOpt" value="bins" />
170 <param name="binSize" value="10" /> 182 <param name="binSize" value="10" />
171 <param name="showOutputSettings" value="no" /> 183 <param name="showOutputSettings" value="no" />
172 <output name="outFileName" file="bamCorrelate_result1.png" ftype="png" compare="sim_size" /> 184 <output name="outFileName" file="bamCorrelate_result1.png" ftype="png" compare="sim_size" />