annotate correctGCBias.xml @ 13:06311d89da81 draft

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