annotate computeGCBias.xml @ 39:c6f1a059bc7d

Uploaded
author bgruening
date Fri, 02 Aug 2013 12:18:55 -0400
parents
children bc8e7315494d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
39
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
1 <tool id="computeGCBias" name="computeGCBias" version="1.0">
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
2 <description></description>
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
3 <stdio>
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
4 <exit_code range="0" level="warning" description="Warning" />
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
5 </stdio>
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
6 <command>
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
7 computeGCBias
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
8 --bamfile '$bamInput'
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
9 --species '$species'
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
10 --GCbiasFrequenciesFile $outFileName
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
11 --fragmentLength $fragmentLength
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
12
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
13 #if $source.ref_source=="history":
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
14 --genome $source.input1
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
15 #else:
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
16 --genome "${source.input1_2bit.fields.path}"
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
17 #end if
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
18
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
19 #if $advancedOpt.showAdvancedOpt == "yes":
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
20 #if str($advancedOpt.region.value) != '':
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
21 --region '$advancedOpt.region'
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
22 #end if
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
23
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
24 --binSize '$advancedOpt.binSize'
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
25 --sampleSize '$advancedOpt.sampleSize'
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
26 --regionSize '$advancedOpt.regionSize'
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
27
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
28 #if $advancedOpt.filterOut:
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
29 --filterOut $advancedOpt.filterOut
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
30 #end if
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
31
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
32 #if $advancedOpt.extraSampling:
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
33 --extraSampling $advancedOpt.extraSampling
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
34 #end if
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
35
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
36 #end if
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
37
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
38 #set move=""
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
39 #if $output.showOutputSettings == "yes"
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
40 #if $output.saveBiasPlot:
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
41 --biasPlot biasPlot.png
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
42 #set move="mv biasPlot.png $biasPlot"
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
43 #end if
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
44 #end if
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
45 ; $move
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
46
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
47 </command>
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
48
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
49 <inputs>
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
50
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
51 <param name="bamInput" format="bam" type="data" label="Input BAM file"
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
52 help="The BAM file must be sorted and indexed."/>
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
53
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
54 <param name="species" type="text" value="" label="Species name abbreviation" />
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
55
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
56 <conditional name="source">
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
57 <param name="ref_source" type="select" label="Reference genome">
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
58 <option value="cached">locally cached</option>
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
59 <option value="history">in your history</option>
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
60 </param>
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
61 <when value="cached">
c6f1a059bc7d 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 the Galaxy team">
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
63 <options from_data_table="lastz_seqs" />
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
64 </param>
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
65 </when>
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
66 <when value="history">
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
67 <param name="input1" type="data" format="twobit" label="Select a reference dataset in 2bit format" />
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
68 </when>
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
69 </conditional>
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
70 <param name="fragmentLength" type="integer" value="300" min="1"
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
71 label="Fragment length used for the sequencing"
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
72 help ="If paired-end reads are used the fragment length is computed based from the bam file."/>
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
73
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
74 <conditional name="advancedOpt">
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
75 <param name="showAdvancedOpt" type="select" label="Show advanced options" >
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
76 <option value="no" selected="true">no</option>
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
77 <option value="yes">yes</option>
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
78 </param>
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
79 <when value="no" />
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
80 <when value="yes">
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
81 <param name="region" type="text" value=""
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
82 label="Region of the genome to limit the operation to"
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
83 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;" />
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
84
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
85 <param name="binSize" type="integer" value="50" min="1"
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
86 label="Bin size in bp"
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
87 help="Size of the bins in bp for the ouput of the bigwig/bedgraph file."/>
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
88
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
89 <param name="sampleSize" type="integer" value="50000000" min="1"
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
90 label="Number of sampling points to be considered" />
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
91
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
92 <param name="regionSize" type="integer" value="300" min="1"
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
93 label="Region size"
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
94 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."/>
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
95
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
96 <param name="filterOut" type="data" format="bed" optional="true"
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
97 label="BED file containing genomic regions to be excluded from the estimation of the correction"
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
98 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." />
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
99 <param name="extraSampling" type="data" format="bed" optional="true"
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
100 label="BED file containing genomic regions for which extra sampling is required because they are underrepresented in the genome"
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
101 help="" />
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
102 </when>
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
103 </conditional>
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
104
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
105 <conditional name="output" >
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
106 <param name="showOutputSettings" type="select" label="Show additional output options" >
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
107 <option value="no" selected="true">no</option>
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
108 <option value="yes">yes</option>
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
109 </param>
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
110 <when value="no" />
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
111 <when value="yes">
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
112 <param name="saveBiasPlot" type="boolean" label="Save a diagnostic image summarizing the GC bias found on the sample"/>
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
113 </when>
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
114 </conditional>
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
115 </inputs>
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
116 <outputs>
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
117 <data format="tabular" name="outFileName" />
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
118 <data format="png" name="biasPlot" label="${tool.name} on ${on_string}: bias plot">
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
119 <filter>(output['showOutputSettings'] == 'yes' and output['saveBiasPlot'] == True)</filter>
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
120 </data>
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
121 </outputs>
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
122 <help>
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
123
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
124 **What it does**
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
125
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
126 Computes the GC bias ussing Benjamini's method [citation]. The resulting GC
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
127 bias can later be used to plot the bias or to correct the bias.
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
128
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
129 -----
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
130
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
131 .. class:: infomark
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
132
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
133 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`_.
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
134
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
135 This tool is developed by the `Bioinformatics and Deep-Sequencing Unit`_ at the `Max Planck Institute for Immunobiology and Epigenetics`_.
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
136
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
137
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
138 .. _Bioinformatics and Deep-Sequencing Unit: http://www3.ie-freiburg.mpg.de/facilities/research-facilities/bioinformatics-and-deep-sequencing-unit/
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
139 .. _Max Planck Institute for Immunobiology and Epigenetics: http://www3.ie-freiburg.mpg.de
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
140 .. _Fidel Ramirez: ramirez@ie-freiburg.mpg.de
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
141
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
142 </help>
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
143
c6f1a059bc7d Uploaded
bgruening
parents:
diff changeset
144 </tool>