annotate correctGCBias.xml @ 6:c5847db0cb41 draft

Uploaded
author bgruening
date Wed, 14 Aug 2013 07:18:18 -0400
parents 1f312af2f8db
children 73761f33f198
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">
c5847db0cb41 Uploaded
bgruening
parents: 5
diff changeset
2 <description>uses the output from computeGCBias to generate corrected BAM files</description>
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
3 <requirements>
6
c5847db0cb41 Uploaded
bgruening
parents: 5
diff changeset
4 <requirement type="package" version="1.5.1_df852fa1ef13251a17274ee18fbf919fbc515079">deepTools</requirement>
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
5 <requirement type="package" version="0.1">ucsc_tools</requirement>
6
c5847db0cb41 Uploaded
bgruening
parents: 5
diff changeset
6 <requirement type="package" >deepTools</requirement>
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
7 </requirements>
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
1
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
20 --bamfile '$temp_bam_path'
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
21 --species '$species'
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
22 --GCbiasFrequenciesFile $GCbiasFrequenciesFile
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
23
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
24 #if $source.ref_source=="history":
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
25 --genome $source.input1
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
26 #else:
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
27 --genome "${source.input1_2bit.fields.path}"
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
28 #end if
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
29
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
30 #if $advancedOpt.showAdvancedOpt == "yes":
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
31 #if str($advancedOpt.region.value) != '':
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
32 --region '$advancedOpt.region'
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
33 #end if
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
34
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
35 --binSize '$advancedOpt.binSize'
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
36 #end if
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
37
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
38 #set newoutFileName="corrected."+str($outFileFormat)
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
39
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
40 --correctedFile $newoutFileName; mv $newoutFileName $outFileName
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
41
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
42 </command>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
43
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
44 <inputs>
1
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
45
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
46 <param name="GCbiasFrequenciesFile" type="data" format="tabular" label="Output of computeGCBias" />
1
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
47
6
c5847db0cb41 Uploaded
bgruening
parents: 5
diff changeset
48 <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
49
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
50 <param name="species" type="select" label="Species name abbreviation">
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
51 <option value="hg19">hg19</option>
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
52 <option value="ce10">ce10</option>
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
53 <option value="dm3">dm3</option>
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
54 <option value="mm9">mm9</option>
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
55 </param>
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
56
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
57 <conditional name="source">
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
58 <param name="ref_source" type="select" label="Reference genome">
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
59 <option value="cached">locally cached</option>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
60 <option value="history">in your history</option>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
61 </param>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
62 <when value="cached">
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
63 <param name="input1_2bit" type="select" label="Using reference genome" help="If your genome of interest is not listed, contact your Galaxy team">
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
64 <options from_data_table="deepTools_seqs" />
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
65 </param>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
66 </when>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
67 <when value="history">
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
68 <param name="input1" type="data" format="twobit" label="Select a reference dataset in 2bit format" />
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
69 </when>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
70 </conditional>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
71
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
72 <param name="outFileFormat" type="select" label="File format of the output">
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
73 <option value="bam">bam</option>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
74 <option value="bw">bigwig</option>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
75 <option value="bg">bedgraph</option>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
76 </param>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
77
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
78 <conditional name="advancedOpt">
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
79 <param name="showAdvancedOpt" type="select" label="Show advanced options" >
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
80 <option value="no" selected="true">no</option>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
81 <option value="yes">yes</option>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
82 </param>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
83 <when value="no" />
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
84 <when value="yes">
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
85 <param name="region" type="text" value=""
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
86 label="Region of the genome to limit the operation to"
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
87 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
88
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
89 <param name="binSize" type="integer" value="50" min="1"
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
90 label="Bin size in bp"
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
91 help="Size of the bins in bp for the ouput of the bigwig/bedgraph file."/>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
92 </when>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
93 </conditional>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
94 </inputs>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
95
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
96 <outputs>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
97 <data format="bam" name="outFileName">
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
98 <change_format>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
99 <when input="outFileFormat" value="bw" format="bigwig" />
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
100 <when input="outFileFormat" value="bam" format="bam" />
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
101 <when input="outFileFormat" value="bg" format="bedgraph" />
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
102 </change_format>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
103 </data>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
104 </outputs>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
105 <help>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
106
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
107 **What it does**
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
108
5
1f312af2f8db Uploaded
bgruening
parents: 1
diff changeset
109 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
110 The resulting BAM files can be used in any downstream analyses, but be aware that you should not filter out duplicates from here on.
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
111 -----
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
112
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
113 .. class:: infomark
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
114
6
c5847db0cb41 Uploaded
bgruening
parents: 5
diff changeset
115 If you would like to give us feedback or you run into any trouble, please send an email to deeptools@googlegroups.com
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
116
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
117 This tool is developed by the `Bioinformatics and Deep-Sequencing Unit`_ at the `Max Planck Institute for Immunobiology and Epigenetics`_.
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
118
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
119
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
120 .. _Bioinformatics and Deep-Sequencing Unit: http://www3.ie-freiburg.mpg.de/facilities/research-facilities/bioinformatics-and-deep-sequencing-unit/
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
121 .. _Max Planck Institute for Immunobiology and Epigenetics: http://www3.ie-freiburg.mpg.de
6
c5847db0cb41 Uploaded
bgruening
parents: 5
diff changeset
122
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
123
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
124 </help>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
125
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
126 </tool>