annotate correctGCBias.xml @ 47:7d6d2f91843e draft

Uploaded
author bgruening
date Tue, 01 Apr 2014 12:31:58 -0400
parents b9feca1f07f0
children 72d1d7c68bd3
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
45
b9feca1f07f0 Uploaded
bgruening
parents: 44
diff changeset
1 <tool id="deeptools_correctGCBias" name="correctGCBias" version="@WRAPPER_VERSION@.0">
10
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
2 <description>uses the output from computeGCBias to generate corrected BAM files</description>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
3 <expand macro="requirements" />
22
8710187d1eb5 Uploaded
bgruening
parents: 21
diff changeset
4 <expand macro="stdio" />
10
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
5 <macros>
34
934b9fccabd4 Uploaded
bgruening
parents: 33
diff changeset
6 <token name="@BINARY@">correctGCBias</token>
10
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
7 <import>deepTools_macros.xml</import>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
8 </macros>
28
1e5fcb1555de Uploaded
bgruening
parents: 24
diff changeset
9 <command>
1e5fcb1555de Uploaded
bgruening
parents: 24
diff changeset
10 #import tempfile
1e5fcb1555de Uploaded
bgruening
parents: 24
diff changeset
11 #set $temp_dir = os.path.abspath(tempfile.mkdtemp())
1
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
12
28
1e5fcb1555de Uploaded
bgruening
parents: 24
diff changeset
13 #set $temp_bam_handle = tempfile.NamedTemporaryFile( dir=$temp_dir )
1e5fcb1555de Uploaded
bgruening
parents: 24
diff changeset
14 #set $temp_bam_path = $temp_bam_handle.name + '.bam'
1e5fcb1555de Uploaded
bgruening
parents: 24
diff changeset
15 #silent $temp_bam_handle.close()
1e5fcb1555de Uploaded
bgruening
parents: 24
diff changeset
16 #silent os.system("ln -s %s %s" % (str($bamInput), $temp_bam_path))
1e5fcb1555de Uploaded
bgruening
parents: 24
diff changeset
17 #silent os.system("ln -s %s %s.bai" % (str($bamInput.metadata.bam_index), $temp_bam_path))
1
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
18
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
19
28
1e5fcb1555de Uploaded
bgruening
parents: 24
diff changeset
20 correctGCBias
16
d0667be9cb0c Uploaded
bgruening
parents: 10
diff changeset
21
28
1e5fcb1555de Uploaded
bgruening
parents: 24
diff changeset
22 @THREADS@
16
d0667be9cb0c Uploaded
bgruening
parents: 10
diff changeset
23
28
1e5fcb1555de Uploaded
bgruening
parents: 24
diff changeset
24 --bamfile '$temp_bam_path'
1e5fcb1555de Uploaded
bgruening
parents: 24
diff changeset
25 --GCbiasFrequenciesFile $GCbiasFrequenciesFile
10
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
26
28
1e5fcb1555de Uploaded
bgruening
parents: 24
diff changeset
27 @reference_genome_source@
10
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
28
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
29
28
1e5fcb1555de Uploaded
bgruening
parents: 24
diff changeset
30 #if $effectiveGenomeSize.effectiveGenomeSize_opt == "specific":
1e5fcb1555de Uploaded
bgruening
parents: 24
diff changeset
31 --effectiveGenomeSize $effectiveGenomeSize.effectiveGenomeSize
1e5fcb1555de Uploaded
bgruening
parents: 24
diff changeset
32 #else:
1e5fcb1555de Uploaded
bgruening
parents: 24
diff changeset
33 --effectiveGenomeSize $effectiveGenomeSize.effectiveGenomeSize_opt
1e5fcb1555de Uploaded
bgruening
parents: 24
diff changeset
34 #end if
10
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
35
43
c5787c91cab8 Uploaded
bgruening
parents: 41
diff changeset
36 #if str($region).strip() != '':
c5787c91cab8 Uploaded
bgruening
parents: 41
diff changeset
37 --region '$region'
40
20f8dafb554f Uploaded
bgruening
parents: 37
diff changeset
38 #end if
20f8dafb554f Uploaded
bgruening
parents: 37
diff changeset
39
28
1e5fcb1555de Uploaded
bgruening
parents: 24
diff changeset
40 #if $advancedOpt.showAdvancedOpt == "yes":
1e5fcb1555de Uploaded
bgruening
parents: 24
diff changeset
41 --binSize '$advancedOpt.binSize'
1e5fcb1555de Uploaded
bgruening
parents: 24
diff changeset
42 #end if
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
43
41
4cc2d806c27e Uploaded
bgruening
parents: 40
diff changeset
44 ###set newoutFileName="corrected."+str($outFileFormat)
4cc2d806c27e Uploaded
bgruening
parents: 40
diff changeset
45 ##--correctedFile $newoutFileName;
4cc2d806c27e Uploaded
bgruening
parents: 40
diff changeset
46 --correctedFile "corrected.bam";
1
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
47
45
b9feca1f07f0 Uploaded
bgruening
parents: 44
diff changeset
48 ##mv $newoutFileName $outFileName
44
3fc7efe86cfc Uploaded
bgruening
parents: 43
diff changeset
49 mv "corrected.bam" $outFileName
28
1e5fcb1555de Uploaded
bgruening
parents: 24
diff changeset
50 </command>
1e5fcb1555de Uploaded
bgruening
parents: 24
diff changeset
51 <inputs>
1e5fcb1555de Uploaded
bgruening
parents: 24
diff changeset
52 <param name="GCbiasFrequenciesFile" type="data" format="tabular" label="Output of computeGCBias" />
1e5fcb1555de Uploaded
bgruening
parents: 24
diff changeset
53 <param name="bamInput" format="bam" type="data" label="BAM file" help="This should be same file that was used for computeGCbias. The BAM file must be sorted."/>
10
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
54 <expand macro="reference_genome_source" />
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
55 <expand macro="effectiveGenomeSize" />
1
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
56
41
4cc2d806c27e Uploaded
bgruening
parents: 40
diff changeset
57 <!--
28
1e5fcb1555de Uploaded
bgruening
parents: 24
diff changeset
58 <param name="outFileFormat" type="select" label="File format of the output">
1e5fcb1555de Uploaded
bgruening
parents: 24
diff changeset
59 <option value="bam">bam</option>
1e5fcb1555de Uploaded
bgruening
parents: 24
diff changeset
60 <option value="bw">bigwig</option>
1e5fcb1555de Uploaded
bgruening
parents: 24
diff changeset
61 <option value="bg">bedgraph</option>
1e5fcb1555de Uploaded
bgruening
parents: 24
diff changeset
62 </param>
41
4cc2d806c27e Uploaded
bgruening
parents: 40
diff changeset
63 -->
40
20f8dafb554f Uploaded
bgruening
parents: 37
diff changeset
64 <expand macro="region_limit_operation" />
20f8dafb554f Uploaded
bgruening
parents: 37
diff changeset
65
28
1e5fcb1555de Uploaded
bgruening
parents: 24
diff changeset
66 <conditional name="advancedOpt">
1e5fcb1555de Uploaded
bgruening
parents: 24
diff changeset
67 <param name="showAdvancedOpt" type="select" label="Show advanced options" >
1e5fcb1555de Uploaded
bgruening
parents: 24
diff changeset
68 <option value="no" selected="true">no</option>
1e5fcb1555de Uploaded
bgruening
parents: 24
diff changeset
69 <option value="yes">yes</option>
1e5fcb1555de Uploaded
bgruening
parents: 24
diff changeset
70 </param>
1e5fcb1555de Uploaded
bgruening
parents: 24
diff changeset
71 <when value="no" />
1e5fcb1555de Uploaded
bgruening
parents: 24
diff changeset
72 <when value="yes">
1e5fcb1555de Uploaded
bgruening
parents: 24
diff changeset
73 <param name="binSize" type="integer" value="50" min="1"
1e5fcb1555de Uploaded
bgruening
parents: 24
diff changeset
74 label="Bin size in bp"
45
b9feca1f07f0 Uploaded
bgruening
parents: 44
diff changeset
75 help="Size of the bins in bp for the output of the bigwig/bedgraph file."/>
28
1e5fcb1555de Uploaded
bgruening
parents: 24
diff changeset
76 </when>
1e5fcb1555de Uploaded
bgruening
parents: 24
diff changeset
77 </conditional>
1e5fcb1555de Uploaded
bgruening
parents: 24
diff changeset
78 </inputs>
1e5fcb1555de Uploaded
bgruening
parents: 24
diff changeset
79 <outputs>
1e5fcb1555de Uploaded
bgruening
parents: 24
diff changeset
80 <data format="bam" name="outFileName">
41
4cc2d806c27e Uploaded
bgruening
parents: 40
diff changeset
81 <!--<change_format>
28
1e5fcb1555de Uploaded
bgruening
parents: 24
diff changeset
82 <when input="outFileFormat" value="bw" format="bigwig" />
1e5fcb1555de Uploaded
bgruening
parents: 24
diff changeset
83 <when input="outFileFormat" value="bam" format="bam" />
1e5fcb1555de Uploaded
bgruening
parents: 24
diff changeset
84 <when input="outFileFormat" value="bg" format="bedgraph" />
41
4cc2d806c27e Uploaded
bgruening
parents: 40
diff changeset
85 </change_format>-->
28
1e5fcb1555de Uploaded
bgruening
parents: 24
diff changeset
86 </data>
1e5fcb1555de Uploaded
bgruening
parents: 24
diff changeset
87 </outputs>
1e5fcb1555de Uploaded
bgruening
parents: 24
diff changeset
88 <help>
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
89
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
90 **What it does**
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
91
43
c5787c91cab8 Uploaded
bgruening
parents: 41
diff changeset
92 This tool requires the output from computeGCBias to correct a given BAM file according to the method proposed by
c5787c91cab8 Uploaded
bgruening
parents: 41
diff changeset
93 Benjamini and Speed (2012) Nucleic Acids Res.
c5787c91cab8 Uploaded
bgruening
parents: 41
diff changeset
94 The resulting BAM file can be used in any downstream analyses, but be aware that you should not filter out duplicates from here on.
37
2f7edf06a5da Uploaded
bgruening
parents: 34
diff changeset
95
43
c5787c91cab8 Uploaded
bgruening
parents: 41
diff changeset
96 You can find more details on the correctGCBias wiki page: https://github.com/fidelram/deepTools/wiki/QC#wiki-correctGCbias
37
2f7edf06a5da Uploaded
bgruening
parents: 34
diff changeset
97
2f7edf06a5da Uploaded
bgruening
parents: 34
diff changeset
98
10
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
99 **Output files**:
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
100
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
101 - GC-normalized BAM file
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
102
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
103 -----
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
104
10
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
105 @REFERENCES@
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
106
10
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
107 </help>
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
108 </tool>