annotate correctGCBias.xml @ 22:8710187d1eb5 draft

Uploaded
author bgruening
date Thu, 12 Dec 2013 18:11:46 -0500
parents 8436c195dd6c
children e43b4015b4cc
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6
c5847db0cb41 Uploaded
bgruening
parents: 5
diff changeset
1 <tool id="deeptools_correctGCBias" name="correctGCBias" version="1.0.1">
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>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
6 <import>deepTools_macros.xml</import>
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
7 </macros>
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
8 <command>
1
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
9 #import tempfile
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
10 #set $temp_dir = os.path.abspath(tempfile.mkdtemp())
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
11
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
12 #set $temp_bam_handle = tempfile.NamedTemporaryFile( dir=$temp_dir )
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
13 #set $temp_bam_path = $temp_bam_handle.name + '.bam'
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
14 #silent $temp_bam_handle.close()
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
15 #silent os.system("ln -s %s %s" % (str($bamInput), $temp_bam_path))
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
16 #silent os.system("ln -s %s %s.bai" % (str($bamInput.metadata.bam_index), $temp_bam_path))
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
17
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
18
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
19 correctGCBias
16
d0667be9cb0c Uploaded
bgruening
parents: 10
diff changeset
20
d0667be9cb0c Uploaded
bgruening
parents: 10
diff changeset
21 @THREADS@
d0667be9cb0c Uploaded
bgruening
parents: 10
diff changeset
22
1
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
23 --bamfile '$temp_bam_path'
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
24 --GCbiasFrequenciesFile $GCbiasFrequenciesFile
10
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
25
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
26 @reference_genome_source@
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
27
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
28
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
29 #if $effectiveGenomeSize.effectiveGenomeSize_opt == "specific":
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
30 --effectiveGenomeSize $effectiveGenomeSize.effectiveGenomeSize
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
31 #else:
10
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
32 --effectiveGenomeSize $effectiveGenomeSize.effectiveGenomeSize_opt
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
33 #end if
10
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
34
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
35
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
36 #if $advancedOpt.showAdvancedOpt == "yes":
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
37 #if str($advancedOpt.region.value) != '':
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
38 --region '$advancedOpt.region'
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
39 #end if
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
40
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
41 --binSize '$advancedOpt.binSize'
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
42 #end if
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
43
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
44 #set newoutFileName="corrected."+str($outFileFormat)
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
45
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
46 --correctedFile $newoutFileName; mv $newoutFileName $outFileName
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
47
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
48 </command>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
49
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
50 <inputs>
1
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
51
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
52 <param name="GCbiasFrequenciesFile" type="data" format="tabular" label="Output of computeGCBias" />
1
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
53
21
8436c195dd6c Uploaded
bgruening
parents: 16
diff changeset
54 <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."/>
1
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
55
10
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
56 <expand macro="reference_genome_source" />
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
57 <expand macro="effectiveGenomeSize" />
1
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
58
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
59 <param name="outFileFormat" type="select" label="File format of the output">
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
60 <option value="bam">bam</option>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
61 <option value="bw">bigwig</option>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
62 <option value="bg">bedgraph</option>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
63 </param>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
64
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
65 <conditional name="advancedOpt">
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
66 <param name="showAdvancedOpt" type="select" label="Show advanced options" >
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
67 <option value="no" selected="true">no</option>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
68 <option value="yes">yes</option>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
69 </param>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
70 <when value="no" />
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
71 <when value="yes">
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
72 <param name="region" type="text" value=""
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
73 label="Region of the genome to limit the operation to"
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
74 help="This is useful when testing parameters to reduce the computing time. The format is chr:start:end, for example &quot;chr10&quot; or &quot;chr10:456700:891000&quot;" />
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
75
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
76 <param name="binSize" type="integer" value="50" min="1"
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
77 label="Bin size in bp"
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
78 help="Size of the bins in bp for the ouput of the bigwig/bedgraph file."/>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
79 </when>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
80 </conditional>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
81 </inputs>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
82
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
83 <outputs>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
84 <data format="bam" name="outFileName">
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
85 <change_format>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
86 <when input="outFileFormat" value="bw" format="bigwig" />
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
87 <when input="outFileFormat" value="bam" format="bam" />
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
88 <when input="outFileFormat" value="bg" format="bedgraph" />
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
89 </change_format>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
90 </data>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
91 </outputs>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
92 <help>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
93
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
94 **What it does**
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
95
5
1f312af2f8db Uploaded
bgruening
parents: 1
diff changeset
96 This tool requires the output from computeGCBias to correct the given BAM files according to the method proposed by Benjamini and Speed (2012). Nucleic Acids Res.
1f312af2f8db Uploaded
bgruening
parents: 1
diff changeset
97 The resulting BAM files can be used in any downstream analyses, but be aware that you should not filter out duplicates from here on.
10
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
98
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
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
105 .. class:: infomark
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
106
10
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
107 @REFERENCES@
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
108
10
a68a771625d2 Uploaded
bgruening
parents: 9
diff changeset
109 </help>
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
110 </tool>