annotate scatterplot.xml @ 92:66f88a4fe9d9 draft

Uploaded
author bernhardlutz
date Sun, 26 Jan 2014 08:24:01 -0500
parents b061185bcb83
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
90
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
1 <tool id="scatterplot_rpy" name="Scatterplot" version="1.1.0">
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
2 <description>of two numeric columns</description>
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
3 <expand macro="requirements" />
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
4 <macros>
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
5 <import>statistic_tools_macros.xml</import>
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
6 </macros>
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
7 <command interpreter="python">scatterplot.py $input $out_file1 $col1 $col2 "$title" "$xlab" "$ylab"</command>
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
8 <inputs>
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
9 <param name="input" type="data" format="tabular" label="Dataset" help="Dataset missing? See TIP below"/>
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
10 <param name="col1" type="data_column" data_ref="input" numerical="True" label="Numerical column for x axis" />
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
11 <param name="col2" type="data_column" data_ref="input" numerical="True" label="Numerical column for y axis" />
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
12 <param name="title" size="30" type="text" value="Scatterplot" label="Plot title"/>
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
13 <param name="xlab" size="30" type="text" value="V1" label="Label for x axis"/>
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
14 <param name="ylab" size="30" type="text" value="V2" label="Label for y axis"/>
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
15 </inputs>
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
16 <outputs>
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
17 <data format="pdf" name="out_file1" />
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
18 </outputs>
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
19
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
20 <tests>
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
21 <test>
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
22 <param name="input" value="scatterplot_in1.tabular" ftype="tabular"/>
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
23 <param name="col1" value="2"/>
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
24 <param name="col2" value="3"/>
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
25 <param name="title" value="Scatterplot"/>
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
26 <param name="xlab" value="V1"/>
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
27 <param name="ylab" value="V2"/>
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
28 <output name="out_file1" file="scatterplot_out1.pdf" />
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
29 </test>
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
30 </tests>
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
31 <help>
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
32
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
33 .. class:: infomark
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
34
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
35 **TIP:** If your data is not TAB delimited, use *Text Manipulation-&gt;Convert*
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
36
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
37 -----
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
38
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
39 **Syntax**
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
40
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
41 This tool creates a simple scatter plot between two variables containing numeric values of a selected dataset.
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
42
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
43 - All invalid, blank and comment lines in the dataset are skipped. The number of skipped lines is displayed in the resulting history item.
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
44
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
45 - **Plot title** The scatterplot title
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
46 - **Label for x axis** and **Label for y axis** The labels for x and y axis of the scatterplot.
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
47
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
48 -----
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
49
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
50 **Example**
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
51
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
52 - Input file::
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
53
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
54 1 68 4.1
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
55 2 71 4.6
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
56 3 62 3.8
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
57 4 75 4.4
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
58 5 58 3.2
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
59 6 60 3.1
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
60 7 67 3.8
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
61 8 68 4.1
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
62 9 71 4.3
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
63 10 69 3.7
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
64
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
65 - Create a simple scatterplot between the variables in column 2 and column 3 of the above dataset.
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
66
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
67 .. image:: $PATH_TO_IMAGES/images/scatterplot.png
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
68
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
69 </help>
b061185bcb83 Uploaded
bernhardlutz
parents:
diff changeset
70 </tool>