annotate visualization.xml @ 2:67eb55a9debe draft

Uploaded
author s-kaufmann
date Mon, 10 Feb 2014 09:06:15 -0500
parents
children d8da7251bacf
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
1 <tool id="SyntenyMapperVisualization1" name="SyntenyMapperVisualization" version="1.0.0">
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
2 <description>Visualizes micro-rearrangements for one synteny region</description>
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
3
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
4 <requirements>
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
5 <requirement type="set_environment">JAR_PATH</requirement>
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
6 <requirement type="package" version="0.64">circos</requirement>
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
7 <requirement type="set_environment">CIRCOS_SCRIPT_PATH</requirement>
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
8 </requirements>
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
9
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
10 <command>
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
11 java -cp \$JAR_PATH/syntenyMapper.jar de/tum/wzw/visualization/SyntenyPlotterWrapper $syntenyRegion $mappingFile $syntenyFile $out_file1 \$CIRCOS_PATH \$CIRCOS_SCRIPT_PATH $out_file1.files_path
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
12 </command>
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
13
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
14 <inputs>
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
15 <param name="mappingFile" format="tabular" type="data" label="Mapped genes (SyntenyMapper output1)"/>
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
16 <param name="syntenyFile" format="tabular" type="data" size="9" label="Refined synteny regions (SyntenyMapper output2)"/>
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
17 <param name="syntenyRegion" multiple="False" type="select" label="Choose a synteny region">
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
18 <options from_dataset="syntenyFile">
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
19 <column name="name" index="0"/>
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
20 <column name="value" index="0"/>
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
21 <!--<filter type="static_value" name="regular" value="regular" column="9"/>
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
22 <validator type="expression">str(value).find("000") != -1</validator>-->
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
23 <filter type="sort_by" column="0" ref="syntenyFile"/>
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
24 </options>
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
25 </param>
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
26 </inputs>
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
27 <outputs>
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
28 <data format="html" name="out_file1" label="Visualization of Mapping"/>
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
29 </outputs>
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
30 <tests>
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
31 <test>
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
32 <param name="mappingFile" value="hom_sapi-mus_musc-output-mapping"/>
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
33 <param name="syntenyFile" value="hom_sapi-mus_musc-output-synteny"/>
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
34 <param name="syntenyRegion" value="44542"/>
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
35 <output name="out_file3" file="visualization_test.png"/>
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
36 </test>
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
37 </tests>
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
38 <help>
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
39
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
40 This tool visualizes the mapping of genes and out-of-order blocks of genes ("jumped genes") between two organisms for a given synteny region using Circos, effectively illustrating micro-rearrangements.
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
41
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
42 .. class:: infomark
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
43
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
44 Gene boxes are clickable and redirect to ENSEMBL.
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
45
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
46 ----
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
47
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
48 **Input**
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
49
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
50 .. class:: warningmark
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
51
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
52 Correct input format has to be generated with the SyntenyMapper tool.
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
53
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
54 Mapped genes is SyntenyMapper's first output file containing 12 columns in the following format:
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
55
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
56 +---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
57 |#Species1: homo_sapiens |
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
58 +---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
59 |#Species2: mus_musculus |
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
60 +----+----------+--------------------+---------------+---------------+-------------+--------------------+---------------+---------------+-------------+-----+---------+
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
61 |#ID |SyntenyID |ENSEMBL_ID_species1 |Chrom_species1 |Start_species1 |End_species1 |ENSEMBL_ID_species2 |Chrom_species2 |Start_species2 |End_species2 |Type |splitted |
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
62 +----+----------+--------------------+---------------+---------------+-------------+--------------------+---------------+---------------+-------------+-----+---------+
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
63 |0 |445330001 |ENSG00000068793 |15 |22892005 |23006016 |ENSMUSG00000030447 |7 |55841745 |55930700 |gene |'no' |
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
64 +----+----------+--------------------+---------------+---------------+-------------+--------------------+---------------+---------------+-------------+-----+---------+
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
65
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
66
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
67
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
68 Synteny regions need to be updated by SyntenyMapper (second output) and contain information on micro-rearrangements and original synteny blocks in the following format:
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
69
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
70 +------------------------------------------------------------------------------------------------------------------------------------------------------------------+
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
71 |#Species1: homo_sapiens |
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
72 +------------------------------------------------------------------------------------------------------------------------------------------------------------------+
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
73 |#Species2: mus_musculus |
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
74 +-------------+---------------+---------------+-------------+-------------------+---------------+---------------+-------------+-------------------+----------------+
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
75 |#SyntenyID |Chrom_species1 |Start_species1 |End_species1 |Direction_species1 |Chrom_species2 |Start_species2 |End_species2 |Direction_species2 |Status |
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
76 +-------------+---------------+---------------+-------------+-------------------+---------------+---------------+-------------+-------------------+----------------+
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
77 |"4445500027" |10 |13141449 |13180291 |0 |2 |5020642 |5064051 |1 |jumped_internal |
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
78 +-------------+---------------+---------------+-------------+-------------------+---------------+---------------+-------------+-------------------+----------------+
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
79 |"4460700010" |2 |26987152 |27004099 |0 |5 |30647933 |30659731 |1 |jumped_internal |
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
80 +-------------+---------------+---------------+-------------+-------------------+---------------+---------------+-------------+-------------------+----------------+
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
81
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
82 ----
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
83
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
84 **Note**
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
85
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
86 Long synteny region IDs correspond to translocated or inversed regions and will be visualized within the context of their origin synteny region (first 5 digits).
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
87
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
88 ----
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
89
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
90 **Legend**
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
91
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
92 .. image:: $PATH_TO_IMAGES/legend.png
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
93 </help>
67eb55a9debe Uploaded
s-kaufmann
parents:
diff changeset
94 </tool>