annotate scatterplot.xml @ 0:ffcdde989859 draft

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