Mercurial > repos > bgruening > deeptools_bam_coverage
comparison bamCoverage.xml @ 1:36f655a04a57 draft
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit fef8b344925620444d93d8159c0b2731a5777920
author | bgruening |
---|---|
date | Mon, 15 Feb 2016 10:27:58 -0500 |
parents | 19a6007845cc |
children | 10e697ec9bfb |
comparison
equal
deleted
inserted
replaced
0:19a6007845cc | 1:36f655a04a57 |
---|---|
19 | 19 |
20 --binSize $binSize | 20 --binSize $binSize |
21 | 21 |
22 #if $scaling.type=='rpkm': | 22 #if $scaling.type=='rpkm': |
23 --normalizeUsingRPKM | 23 --normalizeUsingRPKM |
24 --scaleFactor $scaling.scaleFactor | |
24 #elif $scaling.type=='1x': | 25 #elif $scaling.type=='1x': |
25 #if $scaling.effectiveGenomeSize.effectiveGenomeSize_opt == "specific": | 26 #if $scaling.effectiveGenomeSize.effectiveGenomeSize_opt == "specific": |
26 --normalizeTo1x $scaling.effectiveGenomeSize.effectiveGenomeSize | 27 --normalizeTo1x $scaling.effectiveGenomeSize.effectiveGenomeSize |
27 #else: | 28 #else: |
28 --normalizeTo1x $scaling.effectiveGenomeSize.effectiveGenomeSize_opt | 29 --normalizeTo1x $scaling.effectiveGenomeSize.effectiveGenomeSize_opt |
29 #end if | 30 #end if |
30 #elif $scaling.type=='own': | |
31 --scaleFactor $scaling.scaleFactor | 31 --scaleFactor $scaling.scaleFactor |
32 #end if | 32 #end if |
33 | 33 |
34 #if str($region).strip() != '': | 34 #if str($region).strip() != '': |
35 --region '$region' | 35 --region '$region' |
154 <output name="outFileName" file="bamCoverage_result4.bg" ftype="bedgraph" /> | 154 <output name="outFileName" file="bamCoverage_result4.bg" ftype="bedgraph" /> |
155 </test> | 155 </test> |
156 </tests> | 156 </tests> |
157 <help> | 157 <help> |
158 <![CDATA[ | 158 <![CDATA[ |
159 **What it does** | 159 |
160 What it does | |
161 -------------- | |
160 | 162 |
161 Given a BAM file, this tool generates a bigWig or bedGraph file of fragment or | 163 Given a BAM file, this tool generates a bigWig or bedGraph file of fragment or |
162 read coverages. The way the method works is by first calculating all the | 164 read coverages. The way the method works is by first calculating all the |
163 number of reads (either extended to match the fragment length or not) that | 165 number of reads (either extended to match the fragment length or not) that |
164 overlap each bin in the genome. The resulting read counts can be normalized | 166 overlap each bin in the genome. The resulting read counts can be normalized |
166 coverage (RPGC). In the case of paired-end mapping, each read mate is treated | 168 coverage (RPGC). In the case of paired-end mapping, each read mate is treated |
167 independently to avoid a bias when a mixture of concordant and discordant | 169 independently to avoid a bias when a mixture of concordant and discordant |
168 pairs is present. This means that *each end* will be extended to match the | 170 pairs is present. This means that *each end* will be extended to match the |
169 fragment length. | 171 fragment length. |
170 | 172 |
173 See the usage hints below. | |
174 | |
171 .. image:: $PATH_TO_IMAGES/norm_IGVsnapshot_indFiles.png | 175 .. image:: $PATH_TO_IMAGES/norm_IGVsnapshot_indFiles.png |
172 | 176 :width: 600 |
173 | 177 :height: 336 |
174 You can find more details on the bamCoverage doc page: https://deeptools.readthedocs.org/en/master/content/tools/bamCoverage.html | 178 |
175 | 179 Output |
176 | 180 ------------- |
177 **Output files**: | 181 |
178 | 182 ``bamCoverage`` produces a coverage file, either in bigWig or bedGraph format, where for each bin the number of overlapping reads (possibly normalized) is noted. |
179 - coverage file either in bigWig or bedGraph format | 183 |
184 Like BAM files, bigWig files are compressed, binary files. If you would like to see the coverage values, choose the bedGraph output. For more information on typical NGS file formats, see our `Glossary <http://deeptools.readthedocs.org/en/latest/content/help_glossary.html#file-formats>`_ | |
185 | |
186 .. image:: $PATH_TO_IMAGES/bamCoverage_output.png | |
187 :width: 600 | |
188 :height: 450 | |
189 | |
190 Usage hints | |
191 ------------ | |
192 | |
193 * A smaller ``bin size`` value will result in a higher resolution of the coverage track but also in a larger file size. | |
194 * The ``1x normalization`` (RPGC) requires the input of a value for the **effective genome size**, which is the mappable part of the reference genome. Of course, this value is species-specific. | |
195 * It might be useful for some studies to exclude certain chromosomes in order to avoid biases, e.g. chromosome X for many mammals where the males contain a pair of each autosome, but often only a single X chromosome. | |
196 * By default, the read length is **NOT** extended! This is the preferred setting for **spliced-read** data like RNA-seq, where one usually wants to rely on the detected read locations only. A read extension would neglect potential splice sites in the unmapped part of the fragment. | |
197 Other data, e.g. ChIP-seq, where fragments are known to map contiuously, should be processed with read extension (``--extendReads [INT]``). | |
198 * For paired-end data, the fragment length is generally defined by the two read mates. The user-provided fragment length is only used as a fallback for singletons or mate reads that map too far apart (with a distance greater than four times the fragment length or if the mates are located on different chromosomes). | |
199 | |
200 WARNING: If you already normalized for GC bias using ``correctGCbias``, you should absolutely **NOT** set the parameter ``--ignoreDuplicates``! | |
201 | |
180 | 202 |
181 ----- | 203 ----- |
182 | 204 |
183 @REFERENCES@ | 205 @REFERENCES@ |
184 ]]> | 206 ]]> |