Source code

Download source archive ↓

upstream-extended/community/tools/rpy_statistics_collection/scatterplot.xml

1<tool id="scatterplot_rpy" name="Scatterplot" version="1.1.0">
2    <description>of two numeric columns</description>
3    <macros>
4        <import>statistic_tools_macros.xml</import>
5    </macros>
6    <expand macro="requirements" />
7    <command interpreter="python">
8<![CDATA[
9        scatterplot.py $input $out_file1 $col1 $col2 "$title" "$xlab" "$ylab"
10]]>
11    </command>
12    <inputs>
13        <param name="input" type="data" format="tabular" label="Dataset" help="Dataset missing? See TIP below"/>
14        <param name="col1" type="data_column" data_ref="input" numerical="True" label="Numerical column for x axis" />
15        <param name="col2" type="data_column" data_ref="input" numerical="True" label="Numerical column for y axis" />
16        <param name="title" type="text" value="Scatterplot" label="Plot title"/>
17        <param name="xlab" type="text" value="V1" label="Label for x axis"/>
18        <param name="ylab" type="text" value="V2" label="Label for y axis"/>
19    </inputs>
20    <outputs>
21        <data format="pdf" name="out_file1" />
22    </outputs>
23    <tests>
24        <test>
25            <param name="input" value="scatterplot_in1.tabular" ftype="tabular"/>
26            <param name="col1" value="2"/>
27            <param name="col2" value="3"/>
28            <param name="title" value="Scatterplot"/>
29            <param name="xlab" value="V1"/>
30            <param name="ylab" value="V2"/>
31            <output name="out_file1" file="scatterplot_out1.pdf" />
32        </test>
33  </tests>
34  <help>
35<![CDATA[
36
37.. class:: infomark
38
39**TIP:** If your data is not TAB delimited, use *Text Manipulation->Convert*
40
41-----
42
43**Syntax**
44
45This tool creates a simple scatter plot between two variables containing numeric values of a selected 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
49- **Plot title** The scatterplot title
50- **Label for x axis** and **Label for y axis** The labels for x and y axis of the scatterplot.
51
52-----
53
54**Example**
55
56- Input file::
57
58    1   68  4.1
59    2   71  4.6
60    3   62  3.8
61    4   75  4.4
62    5   58  3.2
63    6   60  3.1
64    7   67  3.8
65    8   68  4.1
66    9   71  4.3
67    10  69  3.7
68
69- Create a simple scatterplot between the variables in column 2 and column 3 of the above dataset.
70
71.. image:: $PATH_TO_IMAGES/images/scatterplot.png
72
73]]>
74    </help>
75    <expand macro="citations" />
76</tool>