annotate cytosine_report_to_bedgraph.xml @ 0:b3f6f58f454c draft default tip

Uploaded
author charles
date Mon, 14 Nov 2016 04:53:25 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
b3f6f58f454c Uploaded
charles
parents:
diff changeset
1 <tool id="cytosine_report_to_bedgraph" name="Cytosine Report To Bedgraphs" version="0.0.0">
b3f6f58f454c Uploaded
charles
parents:
diff changeset
2
b3f6f58f454c Uploaded
charles
parents:
diff changeset
3 <description>Converts genome-wide cytosine methylation report to Bedgraphs</description>
b3f6f58f454c Uploaded
charles
parents:
diff changeset
4
b3f6f58f454c Uploaded
charles
parents:
diff changeset
5 <requirements>
b3f6f58f454c Uploaded
charles
parents:
diff changeset
6 <requirement type="package" version="2.3.32">igvtools</requirement>
b3f6f58f454c Uploaded
charles
parents:
diff changeset
7 </requirements>
b3f6f58f454c Uploaded
charles
parents:
diff changeset
8
b3f6f58f454c Uploaded
charles
parents:
diff changeset
9 <command interpreter="python">
b3f6f58f454c Uploaded
charles
parents:
diff changeset
10 <![CDATA[
b3f6f58f454c Uploaded
charles
parents:
diff changeset
11 cytosine_report_to_bedgraph_wrapper.py
b3f6f58f454c Uploaded
charles
parents:
diff changeset
12
b3f6f58f454c Uploaded
charles
parents:
diff changeset
13 --tool_dir "$__tool_directory__"
b3f6f58f454c Uploaded
charles
parents:
diff changeset
14
b3f6f58f454c Uploaded
charles
parents:
diff changeset
15 --cytosine_report "$cytosine_report"
b3f6f58f454c Uploaded
charles
parents:
diff changeset
16
b3f6f58f454c Uploaded
charles
parents:
diff changeset
17 --coverage_bedgraph "$coverage_bedgraph"
b3f6f58f454c Uploaded
charles
parents:
diff changeset
18 #if $tdf['tdf_selector']:
b3f6f58f454c Uploaded
charles
parents:
diff changeset
19 --tdf
b3f6f58f454c Uploaded
charles
parents:
diff changeset
20 --igv_genome "${tdf.built_in_igv_genomes_chr_sizes.fields.path}"
b3f6f58f454c Uploaded
charles
parents:
diff changeset
21 --coverage_tdf "$coverage_tdf"
b3f6f58f454c Uploaded
charles
parents:
diff changeset
22 #end if
b3f6f58f454c Uploaded
charles
parents:
diff changeset
23
b3f6f58f454c Uploaded
charles
parents:
diff changeset
24 #if $context:
b3f6f58f454c Uploaded
charles
parents:
diff changeset
25 --context
b3f6f58f454c Uploaded
charles
parents:
diff changeset
26 --CpG_bedgraph "$CpG_bedgraph"
b3f6f58f454c Uploaded
charles
parents:
diff changeset
27 --CHG_bedgraph "$CHG_bedgraph"
b3f6f58f454c Uploaded
charles
parents:
diff changeset
28 --CHH_bedgraph "$CHH_bedgraph"
b3f6f58f454c Uploaded
charles
parents:
diff changeset
29 #if $tdf['tdf_selector']:
b3f6f58f454c Uploaded
charles
parents:
diff changeset
30 --CpG_tdf "$CpG_tdf"
b3f6f58f454c Uploaded
charles
parents:
diff changeset
31 --CHG_tdf "$CHG_tdf"
b3f6f58f454c Uploaded
charles
parents:
diff changeset
32 --CHH_tdf "$CHH_tdf"
b3f6f58f454c Uploaded
charles
parents:
diff changeset
33 #end if
b3f6f58f454c Uploaded
charles
parents:
diff changeset
34 #else
b3f6f58f454c Uploaded
charles
parents:
diff changeset
35 --CXX "$CXX_bedgraph"
b3f6f58f454c Uploaded
charles
parents:
diff changeset
36 #if $tdf['tdf_selector']:
b3f6f58f454c Uploaded
charles
parents:
diff changeset
37 --CXX "$CXX_tdf"
b3f6f58f454c Uploaded
charles
parents:
diff changeset
38 #end if
b3f6f58f454c Uploaded
charles
parents:
diff changeset
39 #end if
b3f6f58f454c Uploaded
charles
parents:
diff changeset
40
b3f6f58f454c Uploaded
charles
parents:
diff changeset
41 --log "$log_report"
b3f6f58f454c Uploaded
charles
parents:
diff changeset
42 ]]>
b3f6f58f454c Uploaded
charles
parents:
diff changeset
43 </command>
b3f6f58f454c Uploaded
charles
parents:
diff changeset
44 <inputs>
b3f6f58f454c Uploaded
charles
parents:
diff changeset
45 <param name="cytosine_report" type="data" format="txt" label="Submit a genome-wide cytosine methylation report" optional="False" />
b3f6f58f454c Uploaded
charles
parents:
diff changeset
46 <param name="context" type="boolean" truevalue="true" falsevalue="false" checked="true" label="Create a bedGraph for each cytosine methylation context?" />
b3f6f58f454c Uploaded
charles
parents:
diff changeset
47 <conditional name="tdf">
b3f6f58f454c Uploaded
charles
parents:
diff changeset
48 <param name="tdf_selector" type="boolean" truevalue="true" falsevalue="false" checked="false" label="Generate a tdf file from each resulting bedGraph?" />
b3f6f58f454c Uploaded
charles
parents:
diff changeset
49 <when value="true">
b3f6f58f454c Uploaded
charles
parents:
diff changeset
50 <param name="built_in_igv_genomes_chr_sizes" type="select" label="Select Reference Genome (igv genomes chr.sizes)" help="If your genome of interest is not listed, contact your Galaxy admin">
b3f6f58f454c Uploaded
charles
parents:
diff changeset
51 <options from_data_table="igv_genomes_chr_sizes">
b3f6f58f454c Uploaded
charles
parents:
diff changeset
52 <filter type="sort_by" column="name"/>
b3f6f58f454c Uploaded
charles
parents:
diff changeset
53 <validator type="no_options" message="No indexes are available for the selected input dataset"/>
b3f6f58f454c Uploaded
charles
parents:
diff changeset
54 </options>
b3f6f58f454c Uploaded
charles
parents:
diff changeset
55 </param>
b3f6f58f454c Uploaded
charles
parents:
diff changeset
56 </when>
b3f6f58f454c Uploaded
charles
parents:
diff changeset
57 <when value="false"></when>
b3f6f58f454c Uploaded
charles
parents:
diff changeset
58 </conditional>
b3f6f58f454c Uploaded
charles
parents:
diff changeset
59 </inputs>
b3f6f58f454c Uploaded
charles
parents:
diff changeset
60
b3f6f58f454c Uploaded
charles
parents:
diff changeset
61 <outputs>
b3f6f58f454c Uploaded
charles
parents:
diff changeset
62 <data name="log_report" format="txt" label="${tool.name} on ${on_string}: Log Report" />
b3f6f58f454c Uploaded
charles
parents:
diff changeset
63 <data name="CpG_bedgraph" format="bedgraph" label="${tool.name} on ${on_string}: CpG context">
b3f6f58f454c Uploaded
charles
parents:
diff changeset
64 <filter>context is True</filter>
b3f6f58f454c Uploaded
charles
parents:
diff changeset
65 </data>
b3f6f58f454c Uploaded
charles
parents:
diff changeset
66 <data name="CHG_bedgraph" format="bedgraph" label="${tool.name} on ${on_string}: CHG context">
b3f6f58f454c Uploaded
charles
parents:
diff changeset
67 <filter>context is True</filter>
b3f6f58f454c Uploaded
charles
parents:
diff changeset
68 </data>
b3f6f58f454c Uploaded
charles
parents:
diff changeset
69 <data name="CHH_bedgraph" format="bedgraph" label="${tool.name} on ${on_string}: CHH context">
b3f6f58f454c Uploaded
charles
parents:
diff changeset
70 <filter>context is True</filter>
b3f6f58f454c Uploaded
charles
parents:
diff changeset
71 </data>
b3f6f58f454c Uploaded
charles
parents:
diff changeset
72 <data name="CXX_bedgraph" format="bedgraph" label="${tool.name} on ${on_string}: CXX">
b3f6f58f454c Uploaded
charles
parents:
diff changeset
73 <filter>context is False</filter>
b3f6f58f454c Uploaded
charles
parents:
diff changeset
74 </data>
b3f6f58f454c Uploaded
charles
parents:
diff changeset
75 <data name="coverage_bedgraph" format="bedgraph" label="${tool.name} on ${on_string}: Coverage" />
b3f6f58f454c Uploaded
charles
parents:
diff changeset
76 <data name="CpG_tdf" format="tdf" label="${tool.name} on ${on_string}: CpG context (tdf)">
b3f6f58f454c Uploaded
charles
parents:
diff changeset
77 <filter>tdf['tdf_selector'] is True and context is True</filter>
b3f6f58f454c Uploaded
charles
parents:
diff changeset
78 </data>
b3f6f58f454c Uploaded
charles
parents:
diff changeset
79 <data name="CHG_tdf" format="tdf" label="${tool.name} on ${on_string}: CHG context (tdf)">
b3f6f58f454c Uploaded
charles
parents:
diff changeset
80 <filter>tdf['tdf_selector'] is True and context is True</filter>
b3f6f58f454c Uploaded
charles
parents:
diff changeset
81 </data>
b3f6f58f454c Uploaded
charles
parents:
diff changeset
82 <data name="CHH_tdf" format="tdf" label="${tool.name} on ${on_string}: CHH context (tdf)">
b3f6f58f454c Uploaded
charles
parents:
diff changeset
83 <filter>tdf['tdf_selector'] is True and context is True</filter>
b3f6f58f454c Uploaded
charles
parents:
diff changeset
84 </data>
b3f6f58f454c Uploaded
charles
parents:
diff changeset
85 <data name="CXX_tdf" format="tdf" label="${tool.name} on ${on_string}: CXX (tdf)">
b3f6f58f454c Uploaded
charles
parents:
diff changeset
86 <filter>context is False and tdf['tdf_selector'] is True</filter>
b3f6f58f454c Uploaded
charles
parents:
diff changeset
87 </data>
b3f6f58f454c Uploaded
charles
parents:
diff changeset
88 <data name="coverage_tdf" format="tdf" label="${tool.name} on ${on_string}: Coverage (tdf)" >
b3f6f58f454c Uploaded
charles
parents:
diff changeset
89 <filter>tdf['tdf_selector'] is True</filter>
b3f6f58f454c Uploaded
charles
parents:
diff changeset
90 </data>
b3f6f58f454c Uploaded
charles
parents:
diff changeset
91 </outputs>
b3f6f58f454c Uploaded
charles
parents:
diff changeset
92
b3f6f58f454c Uploaded
charles
parents:
diff changeset
93 <tests></tests>
b3f6f58f454c Uploaded
charles
parents:
diff changeset
94
b3f6f58f454c Uploaded
charles
parents:
diff changeset
95 <help>
b3f6f58f454c Uploaded
charles
parents:
diff changeset
96 <![CDATA[
b3f6f58f454c Uploaded
charles
parents:
diff changeset
97
b3f6f58f454c Uploaded
charles
parents:
diff changeset
98 **What it does**
b3f6f58f454c Uploaded
charles
parents:
diff changeset
99
b3f6f58f454c Uploaded
charles
parents:
diff changeset
100 | This tool takes as input a genome-wide cytosine methylation report (generated by the tool *Bismark Meth. Extractor*) and converts it into a bedGraph for each cytosine context (CpG, CHG and CHH).
b3f6f58f454c Uploaded
charles
parents:
diff changeset
101 | These bedGraphs display, for a given context, the ratio of methylation of each covered cytosine in the genome.
b3f6f58f454c Uploaded
charles
parents:
diff changeset
102 |
b3f6f58f454c Uploaded
charles
parents:
diff changeset
103 | It also produces a bedGraph displaying the coverage count of each cytosine in the genome (non-covered cytosine are ignored).
b3f6f58f454c Uploaded
charles
parents:
diff changeset
104 |
b3f6f58f454c Uploaded
charles
parents:
diff changeset
105
b3f6f58f454c Uploaded
charles
parents:
diff changeset
106 .. class:: infomark
b3f6f58f454c Uploaded
charles
parents:
diff changeset
107
b3f6f58f454c Uploaded
charles
parents:
diff changeset
108 | The tool outputs offer the possibility to vizualise the methylation signal of covered cytosines thanks to softwares like IGV (*Integrative Genomics Viewer*).
b3f6f58f454c Uploaded
charles
parents:
diff changeset
109 | In this respect, the tool can optionally generate a tdf binary file (*Tiled Data Format*) from each converted bedGraph. Tdf format is indeed better handled by IGV than bedGraph.
b3f6f58f454c Uploaded
charles
parents:
diff changeset
110 ]]>
b3f6f58f454c Uploaded
charles
parents:
diff changeset
111 </help>
b3f6f58f454c Uploaded
charles
parents:
diff changeset
112 </tool>