annotate computeGCBias.xml @ 4:c8a0dc481493 draft

Uploaded
author bgruening
date Mon, 05 Aug 2013 11:36:11 -0400
parents 21d563d5f2b2
children 1f312af2f8db
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
1 <tool id="computeGCBias" name="computeGCBias" version="1.0.1">
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
2 <description></description>
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 </requirements>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
6 <stdio>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
7 <exit_code range="0" level="warning" description="Warning" />
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
8 </stdio>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
9 <command>
1
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
10 #import tempfile
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
11 #set $temp_dir = os.path.abspath(tempfile.mkdtemp())
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
12
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
13 #set $temp_bam_handle = tempfile.NamedTemporaryFile( dir=$temp_dir )
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
14 #set $temp_bam_path = $temp_bam_handle.name + '.bam'
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
15 #silent $temp_bam_handle.close()
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
16 #silent os.system("ln -s %s %s" % (str($bamInput), $temp_bam_path))
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
17 #silent os.system("ln -s %s %s.bai" % (str($bamInput.metadata.bam_index), $temp_bam_path))
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
18
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
19 computeGCBias
1
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
20
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
21 ##ToDo
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
22 --numberOfProcessors 4
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
23
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
24 --bamfile '$temp_bam_path'
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
25 --species '$species'
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
26 --GCbiasFrequenciesFile $outFileName
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
27 --fragmentLength $fragmentLength
1
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
28
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
29 #if $source.ref_source=="history":
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
30 --genome $source.input1
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
31 #else:
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
32 --genome "${source.input1_2bit.fields.path}"
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
33 #end if
1
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
34
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
35 #if $advancedOpt.showAdvancedOpt == "yes":
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
36 #if str($advancedOpt.region.value) != '':
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
37 --region '$advancedOpt.region'
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
38 #end if
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
39
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
40 --binSize '$advancedOpt.binSize'
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
41 --sampleSize '$advancedOpt.sampleSize'
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
42 --regionSize '$advancedOpt.regionSize'
1
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
43
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
44 #if $advancedOpt.filterOut:
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
45 --filterOut $advancedOpt.filterOut
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
46 #end if
1
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
47
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
48 #if $advancedOpt.extraSampling:
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
49 --extraSampling $advancedOpt.extraSampling
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
50 #end if
1
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
51
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
52 #end if
1
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
53
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
54 #if $output.showOutputSettings == "yes"
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
55 #if $output.saveBiasPlot:
1
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
56 --biasPlot biasPlot.png ;
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
57 mv biasPlot.png $biasPlot
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
58 #end if
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
59 #end if
1
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
60
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
61 ; rm $temp_dir -rf
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
62
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
63 </command>
1
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
64 <inputs>
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
65
1
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
66 <param name="bamInput" format="bam" type="data" label="Input BAM file"
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
67 help="The BAM file must be sorted and indexed."/>
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
68 <!--<param name="species" type="text" value="" label="Species name abbreviation" />-->
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
69
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
70 <param name="species" type="select" label="Species name abbreviation">
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
71 <option value="hg19">hg19</option>
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
72 <option value="ce10">ce10</option>
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
73 <option value="dm3">dm3</option>
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
74 <option value="mm9">mm9</option>
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
75 </param>
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
76
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
77 <conditional name="source">
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
78 <param name="ref_source" type="select" label="Reference genome">
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
79 <option value="cached">locally cached</option>
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
80 <option value="history">in your history</option>
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
81 </param>
1
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
82 <when value="cached">
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
83 <param name="input1_2bit" type="select" label="Using reference genome" help="If your genome of interest is not listed, contact the Galaxy team">
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
84 <options from_data_table="deepTools_seqs" />
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
85 </param>
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
86 </when>
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
87 <when value="history">
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
88 <param name="input1" type="data" format="twobit" label="Select a reference dataset in 2bit format" />
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
89 </when>
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
90 </conditional>
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
91 <param name="fragmentLength" type="integer" value="300" min="1"
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
92 label="Fragment length used for the sequencing"
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
93 help ="If paired-end reads are used the fragment length is computed based from the bam file."/>
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
94
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
95 <conditional name="advancedOpt">
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
96 <param name="showAdvancedOpt" type="select" label="Show advanced options" >
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
97 <option value="no" selected="true">no</option>
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
98 <option value="yes">yes</option>
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
99 </param>
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
100 <when value="no" />
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
101 <when value="yes">
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
102 <param name="region" type="text" value=""
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
103 label="Region of the genome to limit the operation to"
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
104 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
105
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
106 <param name="binSize" type="integer" value="50" min="1"
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
107 label="Bin size in bp"
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
108 help="Size of the bins in bp for the ouput of the bigwig/bedgraph file."/>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
109
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
110 <param name="sampleSize" type="integer" value="50000000" min="1"
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
111 label="Number of sampling points to be considered" />
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
112
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
113 <param name="regionSize" type="integer" value="300" min="1"
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
114 label="Region size"
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
115 help ="To plot the reads per GC over a region the size of the region is required. By default, the bin size is set to 300bp, which is close to the standard fragment size for Illumina machines. However, if the depth of sequencing is low a larger bin size will be required, otherwise many bins will not overlap with any read."/>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
116
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
117 <param name="filterOut" type="data" format="bed" optional="true"
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
118 label="BED file containing genomic regions to be excluded from the estimation of the correction"
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
119 help="Such regions usually contain repetitive regions and peaks that if included will bias the correction. It is recommended to filter out known repetitive regions if multi-reads (reads that map to more than one genomic position) were excluded. In the case of ChIP-seq data, it is recommended to first use a peak caller to identify and filter out the identified peaks." />
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
120 <param name="extraSampling" type="data" format="bed" optional="true"
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
121 label="BED file containing genomic regions for which extra sampling is required because they are underrepresented in the genome"
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
122 help="" />
1
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
123 </when>
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
124 </conditional>
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
125
1
21d563d5f2b2 Uploaded
bgruening
parents: 0
diff changeset
126 <conditional name="output" >
0
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
127 <param name="showOutputSettings" type="select" label="Show additional output options" >
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
128 <option value="no" selected="true">no</option>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
129 <option value="yes">yes</option>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
130 </param>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
131 <when value="no" />
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
132 <when value="yes">
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
133 <param name="saveBiasPlot" type="boolean" label="Save a diagnostic image summarizing the GC bias found on the sample"/>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
134 </when>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
135 </conditional>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
136 </inputs>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
137 <outputs>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
138 <data format="tabular" name="outFileName" />
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
139 <data format="png" name="biasPlot" label="${tool.name} on ${on_string}: bias plot">
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
140 <filter>(output['showOutputSettings'] == 'yes' and output['saveBiasPlot'] == True)</filter>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
141 </data>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
142 </outputs>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
143 <help>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
144
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
145 **What it does**
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
146
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
147 Computes the GC bias ussing Benjamini's method [citation]. The resulting GC
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
148 bias can later be used to plot the bias or to correct the bias.
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
149
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
150 -----
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
151
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
152 .. class:: infomark
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
153
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
154 Please acknowledge that this tool **is still in development** and we will be very happy to receive feedback from the users. If you run into any trouble please sent an email to `Fidel Ramirez`_.
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
155
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
156 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
157
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
158
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
159 .. _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
160 .. _Max Planck Institute for Immunobiology and Epigenetics: http://www3.ie-freiburg.mpg.de
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
161 .. _Fidel Ramirez: ramirez@ie-freiburg.mpg.de
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
162
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
163 </help>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
164 </tool>