annotate computeGCBias.xml @ 0:09b65c12a75a draft

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