annotate tools/plotting/bar_chart.xml @ 0:9071e359b9a3

Uploaded
author xuebing
date Fri, 09 Mar 2012 19:37:19 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
1 <tool id="barchart_gnuplot" name="Bar chart">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
2 <description>for multiple columns</description>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
3 <command interpreter="python">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
4 #if $xtic.userSpecified == "Yes" #bar_chart.py $input $xtic.xticColumn $colList "$title" "$ylabel" $ymin $ymax $out_file1 "$pdf_size"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
5 #else #bar_chart.py $input 0 $colList "$title" "$ylabel" $ymin $ymax $out_file1 "$pdf_size"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
6 #end if
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
7 </command>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
8 <inputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
9 <param name="input" type="data" format="tabular" label="Dataset" help="Dataset missing? See TIP below"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
10 <conditional name="xtic">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
11 <param name="userSpecified" type="select" label="Use X Tick labels?" help="see example below">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
12 <option value="Yes">Yes</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
13 <option value="No">No</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
14 </param>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
15 <when value="Yes">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
16 <param name="xticColumn" type="data_column" data_ref="input" numerical="False" label="Use this column for X Tick labels" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
17 </when>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
18 <when value="No">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
19 </when>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
20 </conditional>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
21 <param name="colList" label="Numerical columns" type="data_column" numerical="True" multiple="True" data_ref="input" help="Multi-select list - hold the appropriate key while clicking to select multiple columns" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
22 <param name="title" type="text" size="30" value="Bar Chart" label="Plot title"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
23 <param name="ylabel" type="text" size="30" value="V1" label="Label for Y axis"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
24 <param name="ymin" type="integer" size="4" value="0" label="Minimal value on Y axis" help="set to 0 for autoscaling"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
25 <param name="ymax" type="integer" size="4" value="0" label="Maximal value on Y axis" help="set to 0 for autoscaling"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
26 <param name="pdf_size" type="select" label="Choose chart size (pixels)">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
27 <option value="800,600">Normal: 800 by 600</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
28 <option value="640,480">Small: 640 by 480</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
29 <option value="1480,800">Large: 1480 by 800</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
30 <option value="600,800">Normal Flipped: 600 by 800</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
31 <option value="480,640">Small Flipped: 480 by 640</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
32 <option value="800,1480">Large Flipped: 800 by 1480</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
33 </param>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
34 </inputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
35 <outputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
36 <data format="png" name="out_file1" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
37 </outputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
38 <requirements>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
39 <requirement type="python-module">Gnuplot</requirement>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
40 <requirement type="python-module">Numeric</requirement>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
41 </requirements>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
42 <help>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
43
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
44 **What it does**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
45
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
46 This tool builds a bar chart on one or more columns. Suppose you have dataset like this one::
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
47
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
48 Gene1 10 15
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
49 Gene2 20 14
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
50 Gene3 67 45
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
51 Gene4 55 12
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
52
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
53 Graphing columns 2 and 3 while using column 1 for X Tick Labels will produce the following plot:
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
54
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
55 .. image:: ./static/images/bar_chart.png
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
56 :height: 324
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
57 :width: 540
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
58
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
59 </help>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
60 </tool>