annotate methylation_analysis/methylation_extractor.xml @ 6:4f09ae8138d1 draft

Uploaded
author fcaramia
date Mon, 03 Dec 2012 18:27:21 -0500
parents 282edadee017
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
282edadee017 Uploaded
fcaramia
parents:
diff changeset
1 <tool id="methyation_extractor_tool" name="Methylation Extractor" version="0.7.6">
282edadee017 Uploaded
fcaramia
parents:
diff changeset
2 <description>: extracts the methylation information for individual cytosine</description>
282edadee017 Uploaded
fcaramia
parents:
diff changeset
3 <requirements>
282edadee017 Uploaded
fcaramia
parents:
diff changeset
4 <requirement type="package" version="0.1.16">samtools</requirement>
282edadee017 Uploaded
fcaramia
parents:
diff changeset
5 <requirement type="package" version="0.12.7">bowtie2</requirement>
282edadee017 Uploaded
fcaramia
parents:
diff changeset
6 <requirement type="package" version="0.7.6">bismark</requirement>
282edadee017 Uploaded
fcaramia
parents:
diff changeset
7 </requirements>
282edadee017 Uploaded
fcaramia
parents:
diff changeset
8 <command interpreter="perl">
282edadee017 Uploaded
fcaramia
parents:
diff changeset
9
282edadee017 Uploaded
fcaramia
parents:
diff changeset
10 methylation_extractor_wrapper.pl
282edadee017 Uploaded
fcaramia
parents:
diff changeset
11
282edadee017 Uploaded
fcaramia
parents:
diff changeset
12
282edadee017 Uploaded
fcaramia
parents:
diff changeset
13 "GENOME::${genome.fields.path}"
282edadee017 Uploaded
fcaramia
parents:
diff changeset
14
282edadee017 Uploaded
fcaramia
parents:
diff changeset
15
282edadee017 Uploaded
fcaramia
parents:
diff changeset
16 #if str($no_overlap) == "ON":
282edadee017 Uploaded
fcaramia
parents:
diff changeset
17 "OPTION::--no_overlap"
282edadee017 Uploaded
fcaramia
parents:
diff changeset
18 #end if
282edadee017 Uploaded
fcaramia
parents:
diff changeset
19
282edadee017 Uploaded
fcaramia
parents:
diff changeset
20 #if str($ending) == "single":
282edadee017 Uploaded
fcaramia
parents:
diff changeset
21 "ENDING::-s"
282edadee017 Uploaded
fcaramia
parents:
diff changeset
22 #else
282edadee017 Uploaded
fcaramia
parents:
diff changeset
23 "ENDING::-p"
282edadee017 Uploaded
fcaramia
parents:
diff changeset
24 #end if
282edadee017 Uploaded
fcaramia
parents:
diff changeset
25
282edadee017 Uploaded
fcaramia
parents:
diff changeset
26 #if str($report) == "ON":
282edadee017 Uploaded
fcaramia
parents:
diff changeset
27 "OPTION::--report"
282edadee017 Uploaded
fcaramia
parents:
diff changeset
28 #end if
282edadee017 Uploaded
fcaramia
parents:
diff changeset
29
282edadee017 Uploaded
fcaramia
parents:
diff changeset
30 "OPTION::--bedGraph"
282edadee017 Uploaded
fcaramia
parents:
diff changeset
31
282edadee017 Uploaded
fcaramia
parents:
diff changeset
32 "OPTION::--counts"
282edadee017 Uploaded
fcaramia
parents:
diff changeset
33
282edadee017 Uploaded
fcaramia
parents:
diff changeset
34
282edadee017 Uploaded
fcaramia
parents:
diff changeset
35 "OUTPUT::$output"
282edadee017 Uploaded
fcaramia
parents:
diff changeset
36 "SUMMARY::$summary"
282edadee017 Uploaded
fcaramia
parents:
diff changeset
37
282edadee017 Uploaded
fcaramia
parents:
diff changeset
38 "BAMFILE::$bamfile"
282edadee017 Uploaded
fcaramia
parents:
diff changeset
39
282edadee017 Uploaded
fcaramia
parents:
diff changeset
40
282edadee017 Uploaded
fcaramia
parents:
diff changeset
41 </command>
282edadee017 Uploaded
fcaramia
parents:
diff changeset
42 <inputs>
282edadee017 Uploaded
fcaramia
parents:
diff changeset
43
282edadee017 Uploaded
fcaramia
parents:
diff changeset
44 <param name="genome" type="select" label="Select a reference genome" help="If your genome of interest is not listed, contact the Galaxy team">
282edadee017 Uploaded
fcaramia
parents:
diff changeset
45 <options from_data_table="bismark_indexes">
282edadee017 Uploaded
fcaramia
parents:
diff changeset
46 <filter type="sort_by" column="2"/>
282edadee017 Uploaded
fcaramia
parents:
diff changeset
47 <validator type="no_options" message="No indexes are available for the selected input dataset"/>
282edadee017 Uploaded
fcaramia
parents:
diff changeset
48 </options>
282edadee017 Uploaded
fcaramia
parents:
diff changeset
49 </param>
282edadee017 Uploaded
fcaramia
parents:
diff changeset
50
282edadee017 Uploaded
fcaramia
parents:
diff changeset
51 <param name="bamfile" type="data" format="bam" label="Bam file: bismark output" />
282edadee017 Uploaded
fcaramia
parents:
diff changeset
52
282edadee017 Uploaded
fcaramia
parents:
diff changeset
53 <param name="ending" type="select" label="ending" help="" optional="true">
282edadee017 Uploaded
fcaramia
parents:
diff changeset
54 <option value="single" >single-end</option>
282edadee017 Uploaded
fcaramia
parents:
diff changeset
55 <option value="paired" selected="true">paired-end</option>
282edadee017 Uploaded
fcaramia
parents:
diff changeset
56 </param>
282edadee017 Uploaded
fcaramia
parents:
diff changeset
57
282edadee017 Uploaded
fcaramia
parents:
diff changeset
58 <param name="no_overlap" type="select" label="no-overlap" help="" optional="true">
282edadee017 Uploaded
fcaramia
parents:
diff changeset
59 <option value="ON" selected="true">ON</option>
282edadee017 Uploaded
fcaramia
parents:
diff changeset
60 <option value="OFF">OFF</option>
282edadee017 Uploaded
fcaramia
parents:
diff changeset
61 </param>
282edadee017 Uploaded
fcaramia
parents:
diff changeset
62
282edadee017 Uploaded
fcaramia
parents:
diff changeset
63 <param name="report" type="select" label="Report" help="" optional="true">
282edadee017 Uploaded
fcaramia
parents:
diff changeset
64 <option value="ON" selected="true">ON</option>
282edadee017 Uploaded
fcaramia
parents:
diff changeset
65 <option value="OFF">OFF</option>
282edadee017 Uploaded
fcaramia
parents:
diff changeset
66 </param>
282edadee017 Uploaded
fcaramia
parents:
diff changeset
67
282edadee017 Uploaded
fcaramia
parents:
diff changeset
68 </inputs>
282edadee017 Uploaded
fcaramia
parents:
diff changeset
69 <outputs>
282edadee017 Uploaded
fcaramia
parents:
diff changeset
70 <data format="bedgraph" name="output" label="${tool.name} on ${on_string}">
282edadee017 Uploaded
fcaramia
parents:
diff changeset
71 <actions>
282edadee017 Uploaded
fcaramia
parents:
diff changeset
72 <action type="metadata" name="dbkey">
282edadee017 Uploaded
fcaramia
parents:
diff changeset
73 <option type="from_data_table" name="bismark_indexes" column="1" offset="0">
282edadee017 Uploaded
fcaramia
parents:
diff changeset
74 <filter type="param_value" column="0" value="#" compare="startswith" keep="False"/>
282edadee017 Uploaded
fcaramia
parents:
diff changeset
75 <filter type="param_value" ref="genome" column="0"/>
282edadee017 Uploaded
fcaramia
parents:
diff changeset
76 </option>
282edadee017 Uploaded
fcaramia
parents:
diff changeset
77 </action>
282edadee017 Uploaded
fcaramia
parents:
diff changeset
78 </actions>
282edadee017 Uploaded
fcaramia
parents:
diff changeset
79 </data>
282edadee017 Uploaded
fcaramia
parents:
diff changeset
80 <data name="summary" format="txt" label="${tool.name} summary" />
282edadee017 Uploaded
fcaramia
parents:
diff changeset
81 </outputs>
282edadee017 Uploaded
fcaramia
parents:
diff changeset
82 <help>
282edadee017 Uploaded
fcaramia
parents:
diff changeset
83 |
282edadee017 Uploaded
fcaramia
parents:
diff changeset
84
282edadee017 Uploaded
fcaramia
parents:
diff changeset
85 **Reference**
282edadee017 Uploaded
fcaramia
parents:
diff changeset
86
282edadee017 Uploaded
fcaramia
parents:
diff changeset
87 http://www.bioinformatics.babraham.ac.uk/projects/bismark/
282edadee017 Uploaded
fcaramia
parents:
diff changeset
88
282edadee017 Uploaded
fcaramia
parents:
diff changeset
89 -----
282edadee017 Uploaded
fcaramia
parents:
diff changeset
90
282edadee017 Uploaded
fcaramia
parents:
diff changeset
91 **What it does**
282edadee017 Uploaded
fcaramia
parents:
diff changeset
92
282edadee017 Uploaded
fcaramia
parents:
diff changeset
93
282edadee017 Uploaded
fcaramia
parents:
diff changeset
94
282edadee017 Uploaded
fcaramia
parents:
diff changeset
95 The script reads in a bisulfite read alignment results file
282edadee017 Uploaded
fcaramia
parents:
diff changeset
96 produced by the Bismark bisulfite mapper (BAM file) and extracts the methylation
282edadee017 Uploaded
fcaramia
parents:
diff changeset
97 informationfor individual cytosines. This information is found in the methylation
282edadee017 Uploaded
fcaramia
parents:
diff changeset
98 call field which can contain the following characters:
282edadee017 Uploaded
fcaramia
parents:
diff changeset
99
282edadee017 Uploaded
fcaramia
parents:
diff changeset
100 ::
282edadee017 Uploaded
fcaramia
parents:
diff changeset
101
282edadee017 Uploaded
fcaramia
parents:
diff changeset
102 ~~~ X for methylated C in CHG context (was protected) ~~~
282edadee017 Uploaded
fcaramia
parents:
diff changeset
103
282edadee017 Uploaded
fcaramia
parents:
diff changeset
104 ~~~ x for not methylated C CHG (was converted) ~~~
282edadee017 Uploaded
fcaramia
parents:
diff changeset
105
282edadee017 Uploaded
fcaramia
parents:
diff changeset
106 ~~~ H for methylated C in CHH context (was protected) ~~~
282edadee017 Uploaded
fcaramia
parents:
diff changeset
107
282edadee017 Uploaded
fcaramia
parents:
diff changeset
108 ~~~ h for not methylated C in CHH context (was converted) ~~~
282edadee017 Uploaded
fcaramia
parents:
diff changeset
109
282edadee017 Uploaded
fcaramia
parents:
diff changeset
110 ~~~ Z for methylated C in CpG context (was protected) ~~~
282edadee017 Uploaded
fcaramia
parents:
diff changeset
111
282edadee017 Uploaded
fcaramia
parents:
diff changeset
112 ~~~ z for not methylated C in CpG context (was converted) ~~~
282edadee017 Uploaded
fcaramia
parents:
diff changeset
113
282edadee017 Uploaded
fcaramia
parents:
diff changeset
114 ~~~ . for any bases not involving cytosines ~~~
282edadee017 Uploaded
fcaramia
parents:
diff changeset
115
282edadee017 Uploaded
fcaramia
parents:
diff changeset
116
282edadee017 Uploaded
fcaramia
parents:
diff changeset
117
282edadee017 Uploaded
fcaramia
parents:
diff changeset
118 -----
282edadee017 Uploaded
fcaramia
parents:
diff changeset
119
282edadee017 Uploaded
fcaramia
parents:
diff changeset
120 **Required Parameters**
282edadee017 Uploaded
fcaramia
parents:
diff changeset
121
282edadee017 Uploaded
fcaramia
parents:
diff changeset
122 ::
282edadee017 Uploaded
fcaramia
parents:
diff changeset
123
282edadee017 Uploaded
fcaramia
parents:
diff changeset
124 -s/--single-end Input file(s) are Bismark result file(s) generated from single-end
282edadee017 Uploaded
fcaramia
parents:
diff changeset
125 read data. Specifying either --single-end or --paired-end is
282edadee017 Uploaded
fcaramia
parents:
diff changeset
126 mandatory.
282edadee017 Uploaded
fcaramia
parents:
diff changeset
127
282edadee017 Uploaded
fcaramia
parents:
diff changeset
128 -p/--paired-end Input file(s) are Bismark result file(s) generated from paired-end
282edadee017 Uploaded
fcaramia
parents:
diff changeset
129 read data. Specifying either --paired-end or --single-end is
282edadee017 Uploaded
fcaramia
parents:
diff changeset
130 mandatory.
282edadee017 Uploaded
fcaramia
parents:
diff changeset
131
282edadee017 Uploaded
fcaramia
parents:
diff changeset
132 --no_overlap For paired-end reads it is theoretically possible that read_1 and
282edadee017 Uploaded
fcaramia
parents:
diff changeset
133 read_2 overlap. This option avoids scoring overlapping methylation
282edadee017 Uploaded
fcaramia
parents:
diff changeset
134 calls twice (only methylation calls of read 1 are used for in the process
282edadee017 Uploaded
fcaramia
parents:
diff changeset
135 since read 1 has historically higher quality basecalls than read 2).
282edadee017 Uploaded
fcaramia
parents:
diff changeset
136 Whilst this option removes a bias towards more methylation calls
282edadee017 Uploaded
fcaramia
parents:
diff changeset
137 in the center of sequenced fragments it may de facto remove a sizable
282edadee017 Uploaded
fcaramia
parents:
diff changeset
138 proportion of the data. This option is highly recommended for paired-end
282edadee017 Uploaded
fcaramia
parents:
diff changeset
139 data.
282edadee017 Uploaded
fcaramia
parents:
diff changeset
140
282edadee017 Uploaded
fcaramia
parents:
diff changeset
141 --report Prints out a short methylation summary as well as the paramaters used to run
282edadee017 Uploaded
fcaramia
parents:
diff changeset
142 this script.
282edadee017 Uploaded
fcaramia
parents:
diff changeset
143
282edadee017 Uploaded
fcaramia
parents:
diff changeset
144
282edadee017 Uploaded
fcaramia
parents:
diff changeset
145 -----
282edadee017 Uploaded
fcaramia
parents:
diff changeset
146
282edadee017 Uploaded
fcaramia
parents:
diff changeset
147 **Default Parameters**
282edadee017 Uploaded
fcaramia
parents:
diff changeset
148
282edadee017 Uploaded
fcaramia
parents:
diff changeset
149 ::
282edadee017 Uploaded
fcaramia
parents:
diff changeset
150
282edadee017 Uploaded
fcaramia
parents:
diff changeset
151 --bedGraph After finishing the methylation extraction, the methylation output is written into a
282edadee017 Uploaded
fcaramia
parents:
diff changeset
152 sorted bedGraph file that reports the position of a given cytosine and its methylation
282edadee017 Uploaded
fcaramia
parents:
diff changeset
153 state (in %, seem details below). The methylation extractor output is temporarily split up into
282edadee017 Uploaded
fcaramia
parents:
diff changeset
154 temporary files, one per chromosome (written into the current directory or folder
282edadee017 Uploaded
fcaramia
parents:
diff changeset
155 specified with -o/--output); these temp files are then used for sorting and deleted
282edadee017 Uploaded
fcaramia
parents:
diff changeset
156 afterwards. By default, only cytosines in CpG context will be sorted. The option
282edadee017 Uploaded
fcaramia
parents:
diff changeset
157 '--CX_context' may be used to report all cyosines irrespective of sequence context
282edadee017 Uploaded
fcaramia
parents:
diff changeset
158 (this will take MUCH longer!).
282edadee017 Uploaded
fcaramia
parents:
diff changeset
159
282edadee017 Uploaded
fcaramia
parents:
diff changeset
160
282edadee017 Uploaded
fcaramia
parents:
diff changeset
161
282edadee017 Uploaded
fcaramia
parents:
diff changeset
162 </help>
282edadee017 Uploaded
fcaramia
parents:
diff changeset
163 </tool>
282edadee017 Uploaded
fcaramia
parents:
diff changeset
164
282edadee017 Uploaded
fcaramia
parents:
diff changeset
165