annotate scatterplot.xml @ 1:b4102b163488 draft

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