annotate correctGCBias.xml @ 5:1f312af2f8db draft

Uploaded
author bgruening
date Tue, 06 Aug 2013 08:20:47 -0400
parents 21d563d5f2b2
children c5847db0cb41
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
1 <tool id="correctGCBias" name="correctGCBias" version="1.0.1">
5
1f312af2f8db Uploaded
bgruening
parents: 1
diff changeset
2 <description>use the output from computeGCBias to obtain corrected sample files</description>
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
3 <requirements>
1
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
4 <requirement type="package" version="1.5.1_59e067cce039cb93add04823c9f51cab202f8c2b">deepTools</requirement>
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
5 <requirement type="package" version="0.1">ucsc_tools</requirement>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
6 </requirements>
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 --species '$species'
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
21 --GCbiasFrequenciesFile $GCbiasFrequenciesFile
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
22
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
23 #if $source.ref_source=="history":
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
24 --genome $source.input1
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
25 #else:
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
26 --genome "${source.input1_2bit.fields.path}"
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
27 #end if
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
28
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
29 #if $advancedOpt.showAdvancedOpt == "yes":
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
30 #if str($advancedOpt.region.value) != '':
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
31 --region '$advancedOpt.region'
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
32 #end if
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
33
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
34 --binSize '$advancedOpt.binSize'
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
35 #end if
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
36
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
37 #set newoutFileName="corrected."+str($outFileFormat)
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
38
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
39 --correctedFile $newoutFileName; mv $newoutFileName $outFileName
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
40
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
41 </command>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
42
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
43 <inputs>
1
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
44
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
45 <param name="GCbiasFrequenciesFile" type="data" format="tabular" label="Output of computeGCBias" />
1
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
46
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
47 <param name="bamInput" format="bam" type="data" label="Input BAM file" help="The BAM file must be sorted and indexed."/>
1
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
48
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
49 <param name="species" type="select" label="Species name abbreviation">
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
50 <option value="hg19">hg19</option>
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
51 <option value="ce10">ce10</option>
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
52 <option value="dm3">dm3</option>
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
53 <option value="mm9">mm9</option>
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
54 </param>
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
55
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
56 <conditional name="source">
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
57 <param name="ref_source" type="select" label="Reference genome">
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
58 <option value="cached">locally cached</option>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
59 <option value="history">in your history</option>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
60 </param>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
61 <when value="cached">
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
62 <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
63 <options from_data_table="deepTools_seqs" />
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
64 </param>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
65 </when>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
66 <when value="history">
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
67 <param name="input1" type="data" format="twobit" label="Select a reference dataset in 2bit format" />
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
68 </when>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
69 </conditional>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
70
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
71 <param name="outFileFormat" type="select" label="File format of the output">
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
72 <option value="bam">bam</option>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
73 <option value="bw">bigwig</option>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
74 <option value="bg">bedgraph</option>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
75 </param>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
76
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
77 <conditional name="advancedOpt">
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
78 <param name="showAdvancedOpt" type="select" label="Show advanced options" >
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
79 <option value="no" selected="true">no</option>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
80 <option value="yes">yes</option>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
81 </param>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
82 <when value="no" />
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
83 <when value="yes">
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
84 <param name="region" type="text" value=""
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
85 label="Region of the genome to limit the operation to"
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
86 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
87
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
88 <param name="binSize" type="integer" value="50" min="1"
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
89 label="Bin size in bp"
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
90 help="Size of the bins in bp for the ouput of the bigwig/bedgraph file."/>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
91 </when>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
92 </conditional>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
93 </inputs>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
94
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
95 <outputs>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
96 <data format="bam" name="outFileName">
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
97 <change_format>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
98 <when input="outFileFormat" value="bw" format="bigwig" />
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
99 <when input="outFileFormat" value="bam" format="bam" />
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
100 <when input="outFileFormat" value="bg" format="bedgraph" />
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
101 </change_format>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
102 </data>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
103 </outputs>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
104 <help>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
105
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
106 **What it does**
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
107
5
1f312af2f8db Uploaded
bgruening
parents: 1
diff changeset
108 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
109 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
110 -----
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
111
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
112 .. class:: infomark
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
113
5
1f312af2f8db Uploaded
bgruening
parents: 1
diff changeset
114 If you would like to give us feedback or you run into any trouble, please sent an email to deeptools@googlegroups.com
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
115
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
116 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
117
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
118
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
119 .. _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
120 .. _Max Planck Institute for Immunobiology and Epigenetics: http://www3.ie-freiburg.mpg.de
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
121 .. _Fidel Ramirez: ramirez@ie-freiburg.mpg.de
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
122
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
123 </help>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
124
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
125 </tool>