comparison tools/plotting/histogram2.xml @ 0:9071e359b9a3

Uploaded
author xuebing
date Fri, 09 Mar 2012 19:37:19 -0500
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:9071e359b9a3
1 <tool id="histogram_rpy" name="Histogram" version="1.0.3">
2 <description>of a numeric column</description>
3 <command interpreter="python">histogram.py $input $out_file1 $numerical_column "$title" "$xlab" $breaks $density $frequency</command>
4 <inputs>
5 <param name="input" type="data" format="tabular" label="Dataset" help="Dataset missing? See TIP below"/>
6 <param name="numerical_column" type="data_column" data_ref="input" numerical="True" label="Numerical column for x axis" />
7 <param name="breaks" type="integer" size="4" value="0" label="Number of breaks (bars)"/>
8 <param name="title" type="text" size="30" value="Histogram" label="Plot title"/>
9 <param name="xlab" type="text" size="30" value="V1" label="Label for x axis"/>
10 <param name="density" type="boolean" checked="yes" label="Include smoothed density"/>
11 <param name="frequency" type="boolean" checked="no" label="Plot as frequency (counts)"/>
12 </inputs>
13 <outputs>
14 <data format="pdf" name="out_file1" />
15 </outputs>
16 <tests>
17 <test>
18 <param name="input" value="histogram_in1.tabular" ftype="tabular"/>
19 <param name="numerical_column" value="2"/>
20 <param name="breaks" value="0"/>
21 <param name="title" value="Histogram"/>
22 <param name="xlab" value="V1"/>
23 <param name="density" value="true"/>
24 <param name="frequency" value="false"/>
25 <output name="out_file1" file="histogram_out1.pdf"/>
26 </test>
27 </tests>
28 <requirements>
29 <requirement type="python-module">rpy</requirement>
30 </requirements>
31 <help>
32
33 .. class:: infomark
34
35 **TIP:** To remove comment lines that do not begin with a *#* character, use *Text Manipulation-&gt;Remove beginning*
36
37 .. class:: infomark
38
39 **TIP:** If your data is not TAB delimited, use *Text Manipulation-&gt;Convert*
40
41 -----
42
43 **Syntax**
44
45 This tool computes a histogram of the numerical values in a column of a dataset.
46
47 - All invalid, blank and comment lines in the dataset are skipped. The number of skipped lines is displayed in the resulting history item.
48 - **Column for x axis** - only numerical columns are possible.
49 - **Number of breaks(bars)** - breakpoints between histogram cells. Value of '0' will determine breaks automatically.
50 - **Plot title** - the histogram title.
51 - **Label for x axis** - the label of the x axis for the histogram.
52 - **Include smoothed density** - if checked, the resulting graph will join the given corresponding points with line segments.
53
54 -----
55
56 **Example**
57
58 - Input file::
59
60 1 68 4.1
61 2 71 4.6
62 3 62 3.8
63 4 75 4.4
64 5 58 3.2
65 6 60 3.1
66 7 67 3.8
67 8 68 4.1
68 9 71 4.3
69 10 69 3.7
70
71 - Create a histogram on column 2 of the above dataset.
72
73 .. image:: ./static/images/histogram2.png
74
75 </help>
76 </tool>