annotate scatterplot.xml @ 1:2e7bc1bb2dbe draft default tip

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