annotate correctGCBias.xml @ 31:46009b7883ba draft

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