annotate hilbertvis.xml @ 0:6f6859904b65 draft

Uploaded tool tarball.
author devteam
date Tue, 20 Aug 2013 10:57:23 -0400
parents
children de1d3f4e5277
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
1 <tool id="hgv_hilbertvis" name="HVIS" version="1.0.0">
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
2 <description>visualization of genomic data with the Hilbert curve</description>
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
3
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
4 <command interpreter="bash">
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
5 hilbertvis.sh $input $output $chromInfo "$chrom" $plot_value.score_col $level $mode
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
6 #if isinstance( $input.datatype, $__app__.datatypes_registry.get_datatype_by_extension('gff').__class__)
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
7 1 4 5 7
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
8 #else
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
9 ${input.metadata.chromCol} ${input.metadata.startCol} ${input.metadata.endCol} ${input.metadata.strandCol}
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
10 #end if
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
11 </command>
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
12
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
13 <inputs>
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
14 <param name="input" type="data" format="interval,gff" label="Dataset">
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
15 <validator type="unspecified_build"/>
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
16 <validator type="metadata" check="chromCol" message="chromCol missing"/>
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
17 <validator type="metadata" check="startCol" message="startCol missing"/>
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
18 <validator type="metadata" check="endCol" message="endCol missing"/>
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
19 </param>
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
20 <param name="chrom" type="text" label="Sequence to plot" help="Name of sequence (from the chromosome column in the dataset) to plot. If left blank, the first sequence in the dataset will be plotted."/>
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
21 <conditional name="plot_value">
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
22 <param name="choice" type="select" label="Value to plot">
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
23 <option value="score" selected="true">Score column from dataset</option>
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
24 <option value="exist">Same value for each base (existence)</option>
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
25 </param>
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
26 <when value="score">
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
27 <param name="score_col" type="data_column" data_ref="input" numerical="true" label="Score column"/>
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
28 </when>
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
29 <when value="exist">
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
30 <param name="score_col" type="hidden" value="-1"/>
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
31 </when>
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
32 </conditional>
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
33 <param name="level" type="integer" value="9" label="Level" help="Level of Hilbert curve. The resulting image will have 2&lt;sup&gt;level&lt;/sup&gt; by 2&lt;sup&gt;level&lt;/sup&gt; pixels.">
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
34 <validator type="in_range" min="1" message="The level must be an integer &gt;= 1."/>
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
35 </param>
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
36 <param name="mode" type="select" label="Summarization mode" help="Method used to determine a value for a point in the plot which covers multiple values in the input.">
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
37 <option value="max">Maximal value in each bin</option>
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
38 <option value="min">Minimal value in each bin</option>
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
39 <option value="absmax" selected="true">Maximal absolute value in each bin</option>
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
40 <option value="mean">Mean value of each bin</option>
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
41 </param>
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
42 </inputs>
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
43
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
44 <outputs>
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
45 <data name="output" format="pdf"/>
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
46 </outputs>
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
47
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
48 <tests>
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
49 <test>
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
50 <param name="input" value="hvis_mkar_chr22.tab"/>
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
51 <param name="chrom" value="chr22"/>
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
52 <param name="choice" value="score"/>
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
53 <param name="score_col" value="15"/>
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
54 <param name="level" value="9"/>
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
55 <param name="mode" value="absmax"/>
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
56 <output name="output" file="hvis_mkar_chr22.pdf" compare="sim_size" delta="7168"/>
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
57 </test>
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
58 </tests>
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
59
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
60 <help>
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
61 **Dataset formats**
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
62
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
63 The input format is interval_, and the output is an image in PDF format.
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
64 (`Dataset missing?`_)
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
65
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
66 .. _interval: ${static_path}/formatHelp.html#interval
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
67 .. _Dataset missing?: ${static_path}/formatHelp.html
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
68
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
69 -----
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
70
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
71 **What it does**
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
72
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
73 HilbertVis uses the Hilbert space-filling curve to visualize the structure of
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
74 position-dependent data. It maps the traditional one-dimensional line
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
75 visualization onto a two-dimensional square. For example, here is a diagram
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
76 showing the path of a level-2 Hilbert curve.
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
77
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
78 .. image:: ${static_path}/images/hilbertvisDiagram.png
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
79
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
80 The shade of each pixel represents the value for the corresponding bin of
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
81 consecutive genomic positions, calculated according to the specified
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
82 summarization mode. The pixels are arranged so that bins that are close
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
83 to each other on the data vector are represented by pixels that are close
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
84 to each other in the plot. In particular, adjacent bins are mapped to
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
85 adjacent pixels. Hence, dark spots in a figure represent a peak; the area
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
86 of the spot in the two-dimensional plot is proportional to the width of the
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
87 peak in the one-dimensional data, and the darkness of the spot corresponds to
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
88 the height of the peak.
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
89
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
90 The input file is in interval format, and typically contains a column with
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
91 scores or other numbers, such as conservation scores, SNP density, the
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
92 coverage of aligned reads from ChIP-Seq data, etc.
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
93
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
94 Website: http://www.ebi.ac.uk/huber-srv/hilbert/
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
95
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
96 -----
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
97
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
98 **Examples**
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
99
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
100 Here are some examples from the HilbertVis homepage, using ChIP-Seq data.
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
101
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
102 .. image:: ${static_path}/images/hilbertvis1.png
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
103
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
104 -----
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
105
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
106 .. image:: ${static_path}/images/hilbertvis2.png
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
107
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
108 -----
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
109
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
110 **Reference**
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
111
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
112 Anders S. (2009)
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
113 Visualization of genomic data with the Hilbert curve.
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
114 Bioinformatics. 25(10):1231-5. Epub 2009 Mar 17.
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
115
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
116 </help>
6f6859904b65 Uploaded tool tarball.
devteam
parents:
diff changeset
117 </tool>