annotate correctGCBias.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="correctGCBias" name="correctGCBias" version="1.0">
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
2 <description>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
3 </description>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
4 <requirements>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
5 <requirement type="package" version="1.5.1_98e5d8a61431ea8605c0643d991a1a5d8999b4dc">deepTools</requirement>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
6 <requirement type="package" version="0.1">ucsc_tools</requirement>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
7 </requirements>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
8 <command>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
9 correctGCBias
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
10 --bamfile '$bamInput'
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
11 --species '$species'
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
12 --GCbiasFrequenciesFile $GCbiasFrequenciesFile
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
13
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
14 #if $source.ref_source=="history":
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
15 --genome $source.input1
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
16 #else:
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
17 --genome "${source.input1_2bit.fields.path}"
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
18 #end if
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
19
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
20 #if $advancedOpt.showAdvancedOpt == "yes":
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
21 #if str($advancedOpt.region.value) != '':
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
22 --region '$advancedOpt.region'
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
23 #end if
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
24
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
25 --binSize '$advancedOpt.binSize'
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
26 #end if
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
27
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
28 #set newoutFileName="corrected."+str($outFileFormat)
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
29
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
30 --correctedFile $newoutFileName; mv $newoutFileName $outFileName
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
31
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
32 </command>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
33
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
34 <inputs>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
35
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
36 <param name="GCbiasFrequenciesFile" type="data" format="tabular" label="Output of computeGCBias" />
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
37
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
38 <param name="bamInput" format="bam" type="data" label="Input BAM file" help="The BAM file must be sorted and indexed."/>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
39
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
40 <param name="species" type="text" value="" label="Species name abbreviation" />
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
41
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
42 <conditional name="source">
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
43 <param name="ref_source" type="select" label="Reference genome">
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
44 <option value="cached">locally cached</option>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
45 <option value="history">in your history</option>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
46 </param>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
47 <when value="cached">
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
48 <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
49 <options from_data_table="deepTools_seqs" />
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
50 </param>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
51 </when>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
52 <when value="history">
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
53 <param name="input1" type="data" format="twobit" label="Select a reference dataset in 2bit format" />
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
54 </when>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
55 </conditional>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
56
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
57 <param name="outFileFormat" type="select" label="File format of the output">
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
58 <option value="bam">bam</option>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
59 <option value="bw">bigwig</option>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
60 <option value="bg">bedgraph</option>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
61 </param>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
62
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
63 <conditional name="advancedOpt">
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
64 <param name="showAdvancedOpt" type="select" label="Show advanced options" >
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
65 <option value="no" selected="true">no</option>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
66 <option value="yes">yes</option>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
67 </param>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
68 <when value="no" />
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
69 <when value="yes">
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
70 <param name="region" type="text" value=""
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
71 label="Region of the genome to limit the operation to"
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
72 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
73
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
74 <param name="binSize" type="integer" value="50" min="1"
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
75 label="Bin size in bp"
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
76 help="Size of the bins in bp for the ouput of the bigwig/bedgraph file."/>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
77 </when>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
78 </conditional>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
79 </inputs>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
80
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
81 <outputs>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
82 <data format="bam" name="outFileName">
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
83 <change_format>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
84 <when input="outFileFormat" value="bw" format="bigwig" />
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
85 <when input="outFileFormat" value="bam" format="bam" />
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
86 <when input="outFileFormat" value="bg" format="bedgraph" />
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
87 </change_format>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
88 </data>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
89 </outputs>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
90 <help>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
91
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
92 **What it does**
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
93
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
94 Computes the GC bias ussing Benjamini's method [citation]. The resulting GC
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
95 bias can later be used to plot the bias or to correct the bias.
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
96
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
97 -----
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
98
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
99 .. class:: infomark
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
100
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
101 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
102
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
103 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
104
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
105
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
106 .. _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
107 .. _Max Planck Institute for Immunobiology and Epigenetics: http://www3.ie-freiburg.mpg.de
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
108 .. _Fidel Ramirez: ramirez@ie-freiburg.mpg.de
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
109
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
110 </help>
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
111
09b65c12a75a Uploaded
bgruening
parents:
diff changeset
112 </tool>