Mercurial > repos > bgruening > deeptools

comparison bamFingerprint.xml @ 26:2ad3b027dfcd draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Uploaded
author bgruening
date Thu, 06 Feb 2014 06:40:05 -0500
parents
children bf1b1dcdd67b
comparison
equal deleted inserted replaced
25:d2898b81b912 26:2ad3b027dfcd
1 <tool id="deeptools_bamFingerprint" name="bamFingerprint" version="1.0.4">
2 <description>plots profiles of BAM files; useful for assesing ChIP signal strength</description>
3 <expand macro="requirements" />
4 <expand macro="stdio" />
5 <macros>
6 <token name="@BINARY@">bamFingerprint</token>
7 <import>deepTools_macros.xml</import>
8 </macros>
9 <command>
10 @multiple_input_bams@
11
12 bamFingerprint
13
14 @THREADS@
15
16 --bamfiles #echo " ".join($files)
17 --labels #echo " ".join($labels)
18
19 --fragmentLength $fragmentLength
20
21 #set newoutFileName=str($outFileName)+".png"
22 --plotFile $newoutFileName
23
24 #if $output.showOutputSettings == "yes"
25 --plotFileFormat $output.outFileFormat
26 #if $output.saveRawCounts:
27 --outRawCounts '$outFileRawCounts'
28 #end if
29 #else
30 --plotFileFormat 'png'
31 #end if
32
33 #if str($region).strip() != '':
34 --region '$region'
35 #end if
36
37 #if $advancedOpt.showAdvancedOpt == "yes":
38 --binSize '$advancedOpt.binSize'
39 --numberOfSamples '$advancedOpt.numberOfSamples'
40
41 $advancedOpt.doNotExtendPairedEnds
42 $advancedOpt.ignoreDuplicates
43 $advancedOpt.skipZeros
44
45 #if $advancedOpt.minMappingQuality:
46 --minMappingQuality '$advancedOpt.minMappingQuality'
47 #end if
48 #end if
49 ; mv $newoutFileName $outFileName
50 ; rm $temp_dir -rf
51 </command>
52
53 <inputs>
54 <expand macro="multiple_input_bams" />
55
56
57 <param name="fragmentLength" type="integer" value="200" min="1"
58 label="Length of the average fragment size"/>
59
60 <expand macro="region_limit_operation" />
61
62 <conditional name="advancedOpt">
63 <param name="showAdvancedOpt" type="select" label="Show advanced options" >
64 <option value="no" selected="true">no</option>
65 <option value="yes">yes</option>
66 </param>
67 <when value="no" />
68 <when value="yes">
69 <param name="binSize" type="integer" value="10000" min="1"
70 label="Bin size in bp"
71 help="Length in base pairs for a window used to sample the genome."/>
72
73 <param name="numberOfSamples" type="integer" value="100000" min="1"
74 label="Number of samples"
75 help="Number of samples taken from the genome to compute the scaling factors"/>
76
77 <param name="doNotExtendPairedEnds" type="boolean" truevalue="--doNotExtendPairedEnds" falsevalue=""
78 label="Do not extend paired ends"
79 help="If set, reads are not extended to match the fragment length reported in the BAM file, instead they will be extended to match the fragment length. Default is to extend the reads if paired end information is available."/>
80
81 <param name="ignoreDuplicates" type="boolean" truevalue="--ignoreDuplicates" falsevalue=""
82 label="Ignore duplicates"
83 help="If set, reads that have the same orientation and start position will be considered only once. If reads are paired, the mate position also has to coincide to ignore a read." />
84
85 <param name="minMappingQuality" type="integer" optional="true" value="1" min="1"
86 label="Minimum mapping quality"
87 help= "If set, only reads that have a mapping quality score higher than the given value are considered. *Note* Bowtie's Mapping quality is related to uniqueness: the higher the score, the more unique is a read. A mapping quality defined by Bowtie of 10 or less indicates that there is at least a 1 in 10 chance that the read truly originated elsewhere."/>
88
89 <param name="skipZeros" type="boolean" truevalue="--skipZeros" falsevalue=""
90 label ="Include zeros"
91 help ="If set, then zero counts that happen for *all* BAM files given are ignored. This might have the effect that fewer regions are considered than indicated in the option where the number of samples is defined." />
92 </when>
93 </conditional>
94
95 <conditional name="output">
96 <param name="showOutputSettings" type="select" label="Show advanced output settings">
97 <option value="no" selected="true">no</option>
98 <option value="yes">yes</option>
99 </param>
100 <when value="no" />
101 <when value="yes">
102 <expand macro="input_image_file_format" />
103 <param name="saveRawCounts" type="boolean" label="Save the bin counts"/>
104 </when>
105 </conditional>
106
107 </inputs>
108 <outputs>
109 <expand macro="output_image_file_format" />
110 <data format="tabular" name="outFileRawCounts" label="${tool.name} on ${on_string}: bin counts">
111 <filter>
112 ((
113 output['showOutputSettings'] == 'yes' and
114 output['saveRawCounts'] is True
115 ))
116 </filter>
117 </data>
118 </outputs>
119 <help>
120
121 **What it does**
122
123 This tool is useful to assess the strength of a ChIP (i.e. how clearly the enrichment signal can be separated from the background signal)
124 and it is based on a method developed by Diaz et al. (2012) Stat Appl Genet Mol Biol 11(3).
125
126 The tool first samples indexed BAM files and counts all reads overlapping a window (bin) of specified length.
127 These counts are then sorted according to their rank (the bin with the highest number of reads has the highest rank)
128 and the cumulative sum of read counts are plotted. An ideal input (control sample) with perfect uniform distribution of reads
129 along the genome (i.e. without enrichments in open chromatin etc.) should
130 generate a straight diagonal line. A very specific and strong ChIP enrichment will be indicated by a prominent and steep
131 rise of the cumulative sum towards the highest rank. This means that a big chunk of reads from the ChIP sample is located in
132 few bins which corresponds to high, narrow enrichments seen for transcription factors.
133
134
135 .. image:: $PATH_TO_IMAGES/QC_fingerprint.png
136
137
138 You can find more details on the bamFingerprint wiki page: https://github.com/fidelram/deepTools/wiki/QC#wiki-bamFingerprint
139
140
141 **Output files**:
142
143 - Diagnostic plot
144 - Data matrix of raw counts
145
146 -----
147
148 @REFERENCES@
149
150 </help>
151 </tool>