annotate hilbertvis.xml @ 0:0e80ffa5b7f7 draft

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