annotate tools/plotting/scatterplot.xml @ 1:cdcb0ce84a1b

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