annotate bamFingerprint.xml @ 22:f85c85597f95 draft

Uploaded
author bgruening
date Mon, 03 Feb 2014 18:31:42 -0500
parents 69ff16ba27bd
children 8c452f37c896
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
18
5ea8782d650c Uploaded
bgruening
parents: 16
diff changeset
1 <tool id="deeptools_bamFingerprint" name="bamFingerprint" version="1.0.3">
0
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
2 <description>plots profiles of BAM files; useful for assesing ChIP signal strength</description>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
3 <expand macro="requirements" />
10
135f3bae5c56 Uploaded
bgruening
parents: 0
diff changeset
4 <expand macro="stdio" />
0
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
5 <macros>
18
5ea8782d650c Uploaded
bgruening
parents: 16
diff changeset
6 <token name="@BINARY@">bamFingerprint</token>
0
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
7 <import>deepTools_macros.xml</import>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
8 </macros>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
9 <command>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
10 @multiple_input_bams@
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
11
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
12 bamFingerprint
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
13
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
14 @THREADS@
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
15
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
16 --bamfiles #echo " ".join($files)
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
17 --labels #echo " ".join($labels)
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
18
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
19 --fragmentLength $fragmentLength
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
20
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
21 #set newoutFileName=str($outFileName)+".png"
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
22 --plotFile $newoutFileName
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
23
13
b4c5dd45778a Uploaded
bgruening
parents: 10
diff changeset
24 #if $output.showOutputSettings == "yes"
b4c5dd45778a Uploaded
bgruening
parents: 10
diff changeset
25 --plotFileFormat $output.outFileFormat
b4c5dd45778a Uploaded
bgruening
parents: 10
diff changeset
26 #if $output.saveRawCounts:
0
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
27 --outRawCounts '$outFileRawCounts'
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
28 #end if
13
b4c5dd45778a Uploaded
bgruening
parents: 10
diff changeset
29 #else
b4c5dd45778a Uploaded
bgruening
parents: 10
diff changeset
30 --plotFileFormat 'png'
0
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
31 #end if
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
32
20
69ff16ba27bd Uploaded
bgruening
parents: 18
diff changeset
33 #if str($region).strip() != '':
22
f85c85597f95 Uploaded
bgruening
parents: 20
diff changeset
34 --region '$region'
18
5ea8782d650c Uploaded
bgruening
parents: 16
diff changeset
35 #end if
5ea8782d650c Uploaded
bgruening
parents: 16
diff changeset
36
0
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
37 #if $advancedOpt.showAdvancedOpt == "yes":
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
38 --binSize '$advancedOpt.binSize'
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
39 --numberOfSamples '$advancedOpt.numberOfSamples'
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
40
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
41 $advancedOpt.doNotExtendPairedEnds
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
42 $advancedOpt.ignoreDuplicates
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
43 $advancedOpt.skipZeros
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
44
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
45 #if $advancedOpt.minMappingQuality:
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
46 --minMappingQuality '$advancedOpt.minMappingQuality'
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
47 #end if
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
48 #end if
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
49 ; mv $newoutFileName $outFileName
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
50 ; rm $temp_dir -rf
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
51 </command>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
52
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
53 <inputs>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
54 <expand macro="multiple_input_bams" />
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
55
18
5ea8782d650c Uploaded
bgruening
parents: 16
diff changeset
56
0
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
57 <param name="fragmentLength" type="integer" value="200" min="1"
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
58 label="Length of the average fragment size"/>
18
5ea8782d650c Uploaded
bgruening
parents: 16
diff changeset
59
5ea8782d650c Uploaded
bgruening
parents: 16
diff changeset
60 <expand macro="region_limit_operation" />
5ea8782d650c Uploaded
bgruening
parents: 16
diff changeset
61
0
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
62 <conditional name="advancedOpt">
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
63 <param name="showAdvancedOpt" type="select" label="Show advanced options" >
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
64 <option value="no" selected="true">no</option>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
65 <option value="yes">yes</option>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
66 </param>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
67 <when value="no" />
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
68 <when value="yes">
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
69 <param name="binSize" type="integer" value="10000" min="1"
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
70 label="Bin size in bp"
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
71 help="Length in base pairs for a window used to sample the genome."/>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
72
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
73 <param name="numberOfSamples" type="integer" value="100000" min="1"
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
74 label="Number of samples"
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
75 help="Number of samples taken from the genome to compute the scaling factors"/>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
76
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
77 <param name="doNotExtendPairedEnds" type="boolean" truevalue="--doNotExtendPairedEnds" falsevalue=""
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
78 label="Do not extend paired ends"
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
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."/>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
80
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
81 <param name="ignoreDuplicates" type="boolean" truevalue="--ignoreDuplicates" falsevalue=""
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
82 label="Ignore duplicates"
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
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." />
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
84
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
85 <param name="minMappingQuality" type="integer" optional="true" value="1" min="1"
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
86 label="Minimum mapping quality"
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
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."/>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
88
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
89 <param name="skipZeros" type="boolean" truevalue="--skipZeros" falsevalue=""
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
90 label ="Include zeros"
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
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." />
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
92 </when>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
93 </conditional>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
94
13
b4c5dd45778a Uploaded
bgruening
parents: 10
diff changeset
95 <conditional name="output">
b4c5dd45778a Uploaded
bgruening
parents: 10
diff changeset
96 <param name="showOutputSettings" type="select" label="Show advanced output settings">
0
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
97 <option value="no" selected="true">no</option>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
98 <option value="yes">yes</option>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
99 </param>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
100 <when value="no" />
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
101 <when value="yes">
13
b4c5dd45778a Uploaded
bgruening
parents: 10
diff changeset
102 <expand macro="input_image_file_format" />
0
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
103 <param name="saveRawCounts" type="boolean" label="Save the bin counts"/>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
104 </when>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
105 </conditional>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
106
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
107 </inputs>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
108 <outputs>
13
b4c5dd45778a Uploaded
bgruening
parents: 10
diff changeset
109 <expand macro="output_image_file_format" />
0
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
110 <data format="tabular" name="outFileRawCounts" label="${tool.name} on ${on_string}: bin counts">
13
b4c5dd45778a Uploaded
bgruening
parents: 10
diff changeset
111 <filter>
b4c5dd45778a Uploaded
bgruening
parents: 10
diff changeset
112 ((
16
16310f8b24d5 Uploaded
bgruening
parents: 13
diff changeset
113 output['showOutputSettings'] == 'yes' and
16310f8b24d5 Uploaded
bgruening
parents: 13
diff changeset
114 output['saveRawCounts'] is True
13
b4c5dd45778a Uploaded
bgruening
parents: 10
diff changeset
115 ))
b4c5dd45778a Uploaded
bgruening
parents: 10
diff changeset
116 </filter>
0
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
117 </data>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
118 </outputs>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
119 <help>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
120
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
121 **What it does**
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
122
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
123 This tool is based on a method developed by Diaz et al. (2012). Stat Appl Genet Mol Biol 11(3).
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
124 The resulting plot can be used to assess the strength of a ChIP (for factors that bind to narrow regions).
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
125 The tool first samples indexed BAM files and counts all reads overlapping a window (bin) of specified length.
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
126 These counts are then sorted according to their rank and the cumulative sum of read counts are plotted. An ideal input
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
127 with perfect uniform distribution of reads along the genome (i.e. without enrichments in open chromatin etc.) should
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
128 generate a straight diagonal line. A very specific and strong ChIP enrichment will be indicated by a prominent and steep
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
129 rise of the cumulative sum towards the highest rank. This means that a big chunk of reads from the ChIP sample is located in
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
130 few bins which corresponds to high, narrow enrichments seen for transcription factors.
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
131
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
132
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
133 .. image:: $PATH_TO_IMAGES/QC_fingerprint.png
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
134
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
135
18
5ea8782d650c Uploaded
bgruening
parents: 16
diff changeset
136 You can find more details in the `bamFingerprint wiki`_.
5ea8782d650c Uploaded
bgruening
parents: 16
diff changeset
137
5ea8782d650c Uploaded
bgruening
parents: 16
diff changeset
138 .. _bamFingerprint wiki: https://github.com/fidelram/deepTools/wiki/QC#wiki-bamFingerprint
5ea8782d650c Uploaded
bgruening
parents: 16
diff changeset
139
5ea8782d650c Uploaded
bgruening
parents: 16
diff changeset
140
0
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
141 **Output files**:
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
142
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
143 - Diagnostic plot
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
144 - Data matrix of raw counts
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
145
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
146 -----
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
147
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
148 @REFERENCES@
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
149
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
150 </help>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
151 </tool>