annotate visualization.xml @ 14:acb6cae8bfec draft

Uploaded
author s-kaufmann
date Fri, 15 Aug 2014 09:49:46 -0400
parents 25ec18816c91
children cc66a156025d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
1 <tool id="SyntenyMapperVisualization1" name="SyntenyMapperVisualization" version="1.0.0">
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
2 <description>Visualizes micro-rearrangements for one synteny region</description>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
3
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
4 <requirements>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
5 <requirement type="set_environment">JAR_PATH</requirement>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
6 <requirement type="package" version="0.64">circos</requirement>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
7 <requirement type="set_environment">CIRCOS_SCRIPT_PATH</requirement>
13
25ec18816c91 Uploaded
s-kaufmann
parents: 10
diff changeset
8 <requirement type="package" version="3.0.2">R_3_0_2</requirement>
10
a6c5e5a41025 Uploaded
s-kaufmann
parents: 6
diff changeset
9 <requirement type="set_environment">R_PATH</requirement>
6
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
10 </requirements>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
11
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
12 <command>
10
a6c5e5a41025 Uploaded
s-kaufmann
parents: 6
diff changeset
13 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 $linear \$R_PATH
6
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
14 </command>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
15
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
16 <inputs>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
17 <param name="mappingFile" format="tabular" type="data" label="Mapped genes (SyntenyMapper output1)"/>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
18 <param name="syntenyFile" format="tabular" type="data" size="9" label="Refined synteny regions (SyntenyMapper output2)"/>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
19 <param name="syntenyRegion" multiple="False" type="select" label="Choose a synteny region">
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
20 <options from_dataset="syntenyFile">
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
21 <column name="name" index="0"/>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
22 <column name="value" index="0"/>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
23 <!--<filter type="static_value" name="regular" value="regular" column="9"/>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
24 <validator type="expression">str(value).find("000") != -1</validator>-->
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
25 <filter type="sort_by" column="0" ref="syntenyFile"/>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
26 </options>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
27 </param>
10
a6c5e5a41025 Uploaded
s-kaufmann
parents: 6
diff changeset
28 <param name="linear" type="select" label="Linear">
a6c5e5a41025 Uploaded
s-kaufmann
parents: 6
diff changeset
29 <option value="false">Circular representation</option>
a6c5e5a41025 Uploaded
s-kaufmann
parents: 6
diff changeset
30 <option value="true">Linear representation</option>
a6c5e5a41025 Uploaded
s-kaufmann
parents: 6
diff changeset
31 </param>
6
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
32 </inputs>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
33 <outputs>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
34 <data format="html" name="out_file1" label="Visualization of Mapping"/>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
35 </outputs>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
36 <tests>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
37 <test>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
38 <param name="mappingFile" value="Gene_mapping1.out"/>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
39 <param name="syntenyFile" value="Refined_Synteny_regions2.out"/>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
40 <param name="syntenyRegion" value="44454"/>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
41 <output name="out_file3" file="visualization_test.html"/>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
42 </test>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
43 </tests>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
44 <help>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
45
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
46 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.
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
47
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
48 .. class:: infomark
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
49
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
50 Gene boxes are clickable and redirect to ENSEMBL.
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
51
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
52 ----
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
53
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
54 **Input**
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
55
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
56 .. class:: warningmark
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
57
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
58 Correct input format has to be generated with the SyntenyMapper tool.
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
59
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
60 Mapped genes is SyntenyMapper's first output file containing 12 columns in the following format:
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
61
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
62 +---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
63 |#Species1: homo_sapiens |
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
64 +---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
65 |#Species2: mus_musculus |
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
66 +----+----------+--------------------+---------------+---------------+-------------+--------------------+---------------+---------------+-------------+-----+---------+
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
67 |#ID |SyntenyID |ENSEMBL_ID_species1 |Chrom_species1 |Start_species1 |End_species1 |ENSEMBL_ID_species2 |Chrom_species2 |Start_species2 |End_species2 |Type |splitted |
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
68 +----+----------+--------------------+---------------+---------------+-------------+--------------------+---------------+---------------+-------------+-----+---------+
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
69 |0 |445330001 |ENSG00000068793 |15 |22892005 |23006016 |ENSMUSG00000030447 |7 |55841745 |55930700 |gene |'no' |
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
70 +----+----------+--------------------+---------------+---------------+-------------+--------------------+---------------+---------------+-------------+-----+---------+
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
71
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
72
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
73
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
74 Synteny regions need to be updated by SyntenyMapper (second output) and contain information on micro-rearrangements and original synteny blocks in the following format:
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
75
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
76 +------------------------------------------------------------------------------------------------------------------------------------------------------------------+
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
77 |#Species1: homo_sapiens |
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
78 +------------------------------------------------------------------------------------------------------------------------------------------------------------------+
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
79 |#Species2: mus_musculus |
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
80 +-------------+---------------+---------------+-------------+-------------------+---------------+---------------+-------------+-------------------+----------------+
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
81 |#SyntenyID |Chrom_species1 |Start_species1 |End_species1 |Direction_species1 |Chrom_species2 |Start_species2 |End_species2 |Direction_species2 |Status |
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
82 +-------------+---------------+---------------+-------------+-------------------+---------------+---------------+-------------+-------------------+----------------+
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
83 |"4445500027" |10 |13141449 |13180291 |0 |2 |5020642 |5064051 |1 |jumped_internal |
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
84 +-------------+---------------+---------------+-------------+-------------------+---------------+---------------+-------------+-------------------+----------------+
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
85 |"4460700010" |2 |26987152 |27004099 |0 |5 |30647933 |30659731 |1 |jumped_internal |
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
86 +-------------+---------------+---------------+-------------+-------------------+---------------+---------------+-------------+-------------------+----------------+
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
87
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
88 ----
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
89
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
90 **Note**
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
91
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
92 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).
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
93
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
94 ----
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
95
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
96 **Legend**
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
97
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
98 .. image:: $PATH_TO_IMAGES/legend.png
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
99 </help>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
100 </tool>