Mercurial > repos > bgruening > deeptools
annotate bamCoverage.xml @ 79:9f25cf7f11d9 draft
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 3bc1d1c6f4e28ac7ff8df79fe4e3f00a195938e6-dirty
| author | bgruening |
|---|---|
| date | Tue, 20 Oct 2015 14:41:43 -0400 |
| parents | 9bee2c86eeb1 |
| children |
| rev | line source |
|---|---|
| 61 | 1 <tool id="deeptools_bamCoverage" name="bamCoverage" version="@WRAPPER_VERSION@.0"> |
| 2 <description> generates a coverage bigWig file from a given BAM file. Multiple options are available to count reads and normalize coverage. (bam2bigwig)</description> | |
| 3 <macros> | |
| 4 <token name="@BINARY@">bamCoverage</token> | |
| 5 <import>deepTools_macros.xml</import> | |
| 6 </macros> | |
|
65
9bee2c86eeb1
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit ab1ab06323702186cf0c883d5774720cbb822cb5-dirty
iuc
parents:
61
diff
changeset
|
7 <expand macro="requirements" /> |
| 61 | 8 <command> |
| 9 <![CDATA[ | |
| 10 bamCoverage | |
| 11 | |
| 12 @THREADS@ | |
| 13 | |
| 14 --bam '$bamInput' | |
| 15 --bamIndex ${bamInput.metadata.bam_index} | |
| 16 --outFileName '$outFileName' | |
| 17 --outFileFormat '$outFileFormat' | |
| 18 | |
| 19 --fragmentLength $fragmentLength | |
| 20 --binSize $binSize | |
| 21 | |
| 22 #if $scaling.type=='rpkm': | |
| 23 --normalizeUsingRPKM | |
| 24 #elif $scaling.type=='1x': | |
| 25 #if $scaling.effectiveGenomeSize.effectiveGenomeSize_opt == "specific": | |
| 26 --normalizeTo1x $scaling.effectiveGenomeSize.effectiveGenomeSize | |
| 27 #else: | |
| 28 --normalizeTo1x $scaling.effectiveGenomeSize.effectiveGenomeSize_opt | |
| 29 #end if | |
| 30 #elif $scaling.type=='own': | |
| 31 --scaleFactor $scaling.scaleFactor | |
| 32 #end if | |
| 33 | |
| 34 #if str($region).strip() != '': | |
| 35 --region '$region' | |
| 36 #end if | |
| 37 | |
| 38 #if $advancedOpt.showAdvancedOpt == "yes": | |
| 39 #if $advancedOpt.smoothLength: | |
| 40 --smoothLength '$advancedOpt.smoothLength' | |
| 41 #end if | |
| 42 | |
| 43 $advancedOpt.doNotExtendPairedEnds | |
| 44 $advancedOpt.ignoreDuplicates | |
| 45 | |
| 46 #if $advancedOpt.minMappingQuality: | |
| 47 --minMappingQuality '$advancedOpt.minMappingQuality' | |
| 48 #end if | |
| 49 | |
| 50 --missingDataAsZero $advancedOpt.missingDataAsZero | |
| 51 | |
| 52 ##if str($advancedOpt.ignoreForNormalization).strip() != '': | |
| 53 ## --ignoreForNormalization $advancedOpt.ignoreForNormalization | |
| 54 ##end if | |
|
65
9bee2c86eeb1
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit ab1ab06323702186cf0c883d5774720cbb822cb5-dirty
iuc
parents:
61
diff
changeset
|
55 #if $samFlag: |
|
9bee2c86eeb1
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit ab1ab06323702186cf0c883d5774720cbb822cb5-dirty
iuc
parents:
61
diff
changeset
|
56 --samFlag $samFlag |
|
9bee2c86eeb1
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit ab1ab06323702186cf0c883d5774720cbb822cb5-dirty
iuc
parents:
61
diff
changeset
|
57 #end if |
| 61 | 58 #end if |
| 59 ]]> | |
| 60 </command> | |
| 61 | |
| 62 <inputs> | |
| 63 <param name="bamInput" format="bam" type="data" label="BAM file" | |
| 64 help="The BAM file must be sorted."/> | |
| 65 | |
| 66 <param name="fragmentLength" type="integer" value="200" min="1" | |
| 67 label="Length of the average fragment size" | |
| 68 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. If this value is set to the read length or smaller, the read will not be extended. *Warning* the fragment length affects the normalization to 1x (see "normalize coverage to 1x"). Sequencing depth is defined as: (total number of mapped reads * fragment length) / effective genome size. *NOTE*: If the BAM files contain mated and unmated paired-end reads, unmated reads will be extended to match the fragment length. (--fragmentLength)"/> | |
| 69 | |
| 70 <param name="binSize" type="integer" value="50" min="1" | |
| 71 label="Bin size in bp" | |
| 72 help="The genome will be divided in bins (also called tiles) of the specified length. For each bin the overlaping number of fragments (or reads) will be reported. If only half a fragment overlaps, this fraction will be reported. "/> | |
| 73 | |
| 74 <conditional name="scaling"> | |
| 75 <param name="type" type="select" label="Scaling/Normalization method" > | |
| 76 <option value="1x">Normalize coverage to 1x</option> | |
| 77 <option value="rpkm">Normalize to fragments (reads) per kilobase per million (RPKM)</option> | |
| 78 <option value="own">Set your own scaling factor</option> | |
| 79 <option value="no">Do not normalize or scale</option> | |
| 80 </param> | |
| 81 <when value="rpkm"/> | |
| 82 <when value="no"/> | |
| 83 <when value="1x"> | |
| 84 <expand macro="effectiveGenomeSize" /> | |
| 85 </when> | |
| 86 <when value="own"> | |
| 87 <param name="scaleFactor" type="float" value="1" size="3" | |
| 88 label="Scale factor to multiply all values" /> | |
| 89 </when> | |
| 90 </conditional> | |
| 91 | |
| 92 <param name="outFileFormat" type="select" label="Coverage file format"> | |
| 93 <option value="bigwig" selected="true">bigwig</option> | |
| 94 <option value="bedgraph">bedgraph</option> | |
| 95 </param> | |
| 96 | |
| 97 <expand macro="region_limit_operation" /> | |
| 98 | |
| 99 <conditional name="advancedOpt"> | |
| 100 <param name="showAdvancedOpt" type="select" label="Show advanced options" > | |
| 101 <option value="no" selected="true">no</option> | |
| 102 <option value="yes">yes</option> | |
| 103 </param> | |
| 104 <when value="no" /> | |
| 105 <when value="yes"> | |
| 106 <param name="smoothLength" type="integer" value="1" optional="true" min="1" | |
| 107 label="Smooth values using the following length (in bp)" | |
| 108 help ="The smooth length defines a window, larger than the bin size, to average the number of reads. For example, if the bin size is set to 20 bp and the smooth length is set to 60 bp, then, for each bin size the average of it and its left and right neighbors is considered. Any value smaller than the bin size will be ignored and no smoothing will be applied. (--smoothLength)"/> | |
| 109 | |
| 110 <expand macro="doNotExtendPairedEnds" /> | |
| 111 <expand macro="ignoreDuplicates" /> | |
| 112 <expand macro="minMappingQuality" /> | |
| 113 <expand macro="missingDataAsZero" /> | |
|
65
9bee2c86eeb1
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit ab1ab06323702186cf0c883d5774720cbb822cb5-dirty
iuc
parents:
61
diff
changeset
|
114 <expand macro="samFlag" /> |
| 61 | 115 <!-- <param name="ignoreForNormalization" type="text" value="" size="50" |
| 116 label="regions that should be excluded for calculating the scaling factor" | |
| 117 help="Sometimes it makes sense to exclude certain regions when calculating the scaling factor. For example, if you know some regions that you suspect to be present more often in your sample's genome than in the reference genome that will therefore accumulate reads (CNV). Another typical example is the single X chromosome in male samples that should be scaled separately from the diploid autosomes. For example chrX,chrY,chr3. or chr10:12220-128932" /> | |
| 118 --> | |
| 119 </when> | |
| 120 </conditional> | |
| 121 </inputs> | |
| 122 <outputs> | |
| 123 <data format="bigwig" name="outFileName"> | |
| 124 <change_format> | |
| 125 <when input="outFileFormat" value="bigwig" format="bigwig" /> | |
| 126 <when input="outFileFormat" value="bedgraph" format="bedgraph" /> | |
| 127 </change_format> | |
| 128 </data> | |
| 129 </outputs> | |
| 130 <tests> | |
| 131 <test> | |
| 132 <param name="bamInput" value="bowtie2-test1.bam" ftype="bam" /> | |
| 133 <param name="outFileFormat" value="bigwig" /> | |
| 134 <param name="showAdvancedOpt" value="no" /> | |
| 135 <param name="binSize" value="10" /> | |
| 136 <param name="type" value="no" /> | |
| 137 <output name="outFileName" file="bamCoverage_result1.bw" ftype="bigwig" /> | |
| 138 </test> | |
| 139 <test> | |
| 140 <param name="bamInput" value="bowtie2-test1.bam" ftype="bam" /> | |
| 141 <param name="outFileFormat" value="bigwig" /> | |
| 142 <param name="showAdvancedOpt" value="no" /> | |
| 143 <param name="binSize" value="10" /> | |
| 144 <output name="outFileName" file="bamCoverage_result2.bw" ftype="bigwig" /> | |
| 145 </test> | |
| 146 <test> | |
| 147 <param name="bamInput" value="bowtie2-test1.bam" ftype="bam" /> | |
| 148 <param name="outFileFormat" value="bedgraph" /> | |
| 149 <param name="showAdvancedOpt" value="no" /> | |
| 150 <param name="binSize" value="10" /> | |
| 151 <output name="outFileName" file="bamCoverage_result3.bg" ftype="bedgraph" /> | |
| 152 </test> | |
| 153 <test> | |
| 154 <param name="bamInput" value="phiX.bam" ftype="bam" /> | |
| 155 <param name="outFileFormat" value="bigwig" /> | |
| 156 <param name="showAdvancedOpt" value="no" /> | |
| 157 <param name="binSize" value="10" /> | |
| 158 <output name="outFileName" file="bamCoverage_result4.bw" ftype="bigwig" /> | |
| 159 </test> | |
| 160 <test> | |
| 161 <param name="bamInput" value="phiX.bam" ftype="bam" /> | |
| 162 <param name="outFileFormat" value="bedgraph" /> | |
| 163 <param name="showAdvancedOpt" value="no" /> | |
| 164 <param name="binSize" value="10" /> | |
| 165 <output name="outFileName" file="bamCoverage_result4.bg" ftype="bedgraph" /> | |
| 166 </test> | |
| 167 </tests> | |
| 168 <help> | |
| 169 <![CDATA[ | |
| 170 **What it does** | |
| 171 | |
| 172 Given a BAM file, this tool generates a bigWig or bedGraph file of fragment or | |
| 173 read coverages. The way the method works is by first calculating all the | |
| 174 number of reads (either extended to match the fragment length or not) that | |
| 175 overlap each bin in the genome. The resulting read counts can be normalized | |
| 176 using either a given scaling factor, the RPKM formula or to get a 1x depth of | |
| 177 coverage (RPGC). In the case of paired-end mapping each read mate is treated | |
| 178 independently to avoid a bias when a mixture of concordant and discordant | |
| 179 pairs is present. This means that *each end* will be extended to match the | |
| 180 fragment length. | |
| 181 | |
| 182 .. image:: $PATH_TO_IMAGES/norm_IGVsnapshot_indFiles.png | |
| 183 | |
| 184 | |
| 185 You can find more details on the bamCoverage wiki page: https://github.com/fidelram/deepTools/wiki/Normalizations#wiki-bamCoverage | |
| 186 | |
| 187 | |
| 188 **Output files**: | |
| 189 | |
| 190 - coverage file either in bigWig or bedGraph format | |
| 191 | |
| 192 ----- | |
| 193 | |
| 194 @REFERENCES@ | |
| 195 ]]> | |
| 196 </help> | |
| 197 <expand macro="citations" /> | |
| 198 </tool> |