annotate scatterplot.xml @ 0:c12b0759203b draft

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