Mercurial > repos > bgruening > deeptools

comparison bamCompare.xml @ 43:c5787c91cab8 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Uploaded
author bgruening
date Tue, 04 Feb 2014 09:02:21 -0500
parents 20f8dafb554f
children b9feca1f07f0
comparison
equal deleted inserted replaced
42:ef1232cedacb 43:c5787c91cab8
1 <tool id="deeptools_bamCompare" name="bamCompare" version="1.0.3"> 1 <tool id="deeptools_bamCompare" name="bamCompare" version="1.0.4">
2 <description>normalizes and compares two BAM files to obtain the ratio, log2ratio or difference. (bam2bigwig)</description> 2 <description>normalizes and compares two BAM files to obtain the ratio, log2ratio or difference. (bam2bigwig)</description>
3 <expand macro="requirements" /> 3 <expand macro="requirements" />
4 <expand macro="stdio" /> 4 <expand macro="stdio" />
5 <macros> 5 <macros>
6 <token name="@BINARY@">bamCompare</token> 6 <token name="@BINARY@">bamCompare</token>
45 #end if 45 #end if
46 46
47 #end if 47 #end if
48 #end if 48 #end if
49 49
50 #if str(region).strip() != '': 50 #if str($region).strip() != '':
51 --region 'region' 51 --region '$region'
52 #end if 52 #end if
53 53
54 #if $advancedOpt.showAdvancedOpt == "yes": 54 #if $advancedOpt.showAdvancedOpt == "yes":
55 #if $advancedOpt.smoothLength: 55 #if $advancedOpt.smoothLength:
56 --smoothLength '$advancedOpt.smoothLength' 56 --smoothLength '$advancedOpt.smoothLength'
72 #end if 72 #end if
73 73
74 </command> 74 </command>
75 75
76 <inputs> 76 <inputs>
77 <param name="bamFile1" format="bam" type="data" label="Treatment BAM file" 77 <param name="bamFile1" format="bam" type="data" label="First BAM file (e.g. treated sample)"
78 help="The BAM file must be sorted."/> 78 help="The BAM file must be sorted."/>
79 79
80 <param name="bamFile2" format="bam" type="data" label="BAM file" 80 <param name="bamFile2" format="bam" type="data" label="Second BAM file (e.g. control sample)"
81 help="The BAM file must be sorted."/> 81 help="The BAM file must be sorted."/>
82 82
83 <param name="fragmentLength" type="integer" value="300" min="1" 83 <param name="fragmentLength" type="integer" value="300" min="1"
84 label="Length of the average fragment size" 84 label="Length of the average fragment size"
85 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 &quot;normalize coverage to 1x&quot;). The formula to normalize using the sequencing depth is genomeSize/(number of mapped reads * fragment length). *NOTE*: If the BAM files contain mated and unmated paired-end reads, unmated reads will be extended to match the fragment length."/> 85 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 &quot;normalize coverage to 1x&quot;). The formula to normalize using the sequencing depth is genomeSize/(number of mapped reads * fragment length). *NOTE*: If the BAM files contain mated and unmated paired-end reads, unmated reads will be extended to match the fragment length."/>
90 90
91 <conditional name="scaling"> 91 <conditional name="scaling">
92 <param name="method" type="select" 92 <param name="method" type="select"
93 label="Method to use for scaling the largest sample to the smallest"> 93 label="Method to use for scaling the largest sample to the smallest">
94 <option value="readCount" selected="true">read count</option> 94 <option value="readCount" selected="true">read count</option>
95 <option value="SES">signal extraction scaling (SES)</option> 95 <option value="SES">signal extraction scaling (SES), check the bamFingerprint plot before using it!</option>
96 <option value="own">enter own scaling factors</option> 96 <option value="own">enter own scaling factors</option>
97 </param> 97 </param>
98 <when value="SES"> 98 <when value="SES">
99 <param name="sampleLength" type="integer" value="1000" min="10" 99 <param name="sampleLength" type="integer" value="1000" min="10"
100 label="Length in base pairs used to sample the genome and compute the size or scaling factors to compare the two BAM files " 100 label="Length in base pairs used to sample the genome and compute the size or scaling factors to compare the two BAM files "
203 203
204 204
205 .. image:: $PATH_TO_IMAGES/norm_IGVsnapshot_indFiles.png 205 .. image:: $PATH_TO_IMAGES/norm_IGVsnapshot_indFiles.png
206 206
207 207
208 You can find more details in the `bamCompare wiki`_. 208 You can find more details on the bamCompare wiki page: https://github.com/fidelram/deepTools/wiki/Normalizations#wiki-bamCompare
209
210 .. _bamCompare wiki: https://github.com/fidelram/deepTools/wiki/Normalizations#wiki-bamCompare
211 209
212 210
213 **Output files**: 211 **Output files**:
214 212
215 - same as for bamCoverage, except that you now obtain 1 coverage file that is based on 2 BAM files. 213 - same as for bamCoverage, except that you now obtain 1 coverage file that is based on 2 BAM files.