annotate correctGCBias.xml @ 6:5742b322f956 draft default tip

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