annotate histogram2.xml @ 2:4d2c30376614 draft default tip

"planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/histogram commit 5666c97386c843c109e45acce462243392285b84"
author devteam
date Mon, 27 Jul 2020 07:25:28 +0000
parents a629ef17ee46
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
4d2c30376614 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/histogram commit 5666c97386c843c109e45acce462243392285b84"
devteam
parents: 1
diff changeset
1 <tool id="histogram_rpy" name="Histogram" version="1.0.4">
0
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
2 <description>of a numeric column</description>
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
3 <requirements>
2
4d2c30376614 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/histogram commit 5666c97386c843c109e45acce462243392285b84"
devteam
parents: 1
diff changeset
4 <requirement type="package" version="3.3.2">rpy2</requirement>
4d2c30376614 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/histogram commit 5666c97386c843c109e45acce462243392285b84"
devteam
parents: 1
diff changeset
5 <requirement type="package" version="3.6.0">R</requirement>
0
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
6 </requirements>
2
4d2c30376614 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/histogram commit 5666c97386c843c109e45acce462243392285b84"
devteam
parents: 1
diff changeset
7 <command>
4d2c30376614 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/histogram commit 5666c97386c843c109e45acce462243392285b84"
devteam
parents: 1
diff changeset
8 python '$__tool_directory__/histogram.py'
4d2c30376614 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/histogram commit 5666c97386c843c109e45acce462243392285b84"
devteam
parents: 1
diff changeset
9 '$input'
4d2c30376614 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/histogram commit 5666c97386c843c109e45acce462243392285b84"
devteam
parents: 1
diff changeset
10 '$out_file1'
4d2c30376614 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/histogram commit 5666c97386c843c109e45acce462243392285b84"
devteam
parents: 1
diff changeset
11 $numerical_column
4d2c30376614 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/histogram commit 5666c97386c843c109e45acce462243392285b84"
devteam
parents: 1
diff changeset
12 '$title'
4d2c30376614 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/histogram commit 5666c97386c843c109e45acce462243392285b84"
devteam
parents: 1
diff changeset
13 '$xlab'
4d2c30376614 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/histogram commit 5666c97386c843c109e45acce462243392285b84"
devteam
parents: 1
diff changeset
14 $breaks
4d2c30376614 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/histogram commit 5666c97386c843c109e45acce462243392285b84"
devteam
parents: 1
diff changeset
15 $density
4d2c30376614 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/histogram commit 5666c97386c843c109e45acce462243392285b84"
devteam
parents: 1
diff changeset
16 $frequency
4d2c30376614 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/histogram commit 5666c97386c843c109e45acce462243392285b84"
devteam
parents: 1
diff changeset
17 </command>
0
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
18 <inputs>
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
19 <param name="input" type="data" format="tabular" label="Dataset" help="Dataset missing? See TIP below"/>
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
20 <param name="numerical_column" type="data_column" data_ref="input" numerical="True" label="Numerical column for x axis" />
1
a629ef17ee46 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
21 <param name="breaks" type="integer" value="0" label="Number of breaks (bars)"/>
a629ef17ee46 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
22 <param name="title" type="text" value="Histogram" label="Plot title"/>
a629ef17ee46 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
23 <param name="xlab" type="text" value="V1" label="Label for x axis"/>
0
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
24 <param name="density" type="boolean" checked="yes" label="Include smoothed density"/>
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
25 <param name="frequency" type="boolean" checked="no" label="Plot as frequency (counts)"/>
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
26 </inputs>
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
27 <outputs>
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
28 <data format="pdf" name="out_file1" />
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
29 </outputs>
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
30 <tests>
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
31 <test>
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
32 <param name="input" value="histogram_in1.tabular" ftype="tabular"/>
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
33 <param name="numerical_column" value="2"/>
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
34 <param name="breaks" value="0"/>
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
35 <param name="title" value="Histogram"/>
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
36 <param name="xlab" value="V1"/>
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
37 <param name="density" value="true"/>
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
38 <param name="frequency" value="false"/>
2
4d2c30376614 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/histogram commit 5666c97386c843c109e45acce462243392285b84"
devteam
parents: 1
diff changeset
39 <output name="out_file1" file="histogram_out1.pdf" compare="sim_size"/>
0
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
40 </test>
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
41 </tests>
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
42 <help>
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
43
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
44 .. class:: infomark
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
45
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
46 **TIP:** To remove comment lines that do not begin with a *#* character, use *Text Manipulation-&gt;Remove beginning*
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
47
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
48 .. class:: infomark
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
49
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
50 **TIP:** If your data is not TAB delimited, use *Text Manipulation-&gt;Convert*
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
51
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
52 -----
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
53
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
54 **Syntax**
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
55
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
56 This tool computes a histogram of the numerical values in a column of a dataset.
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
57
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
58 - All invalid, blank and comment lines in the dataset are skipped. The number of skipped lines is displayed in the resulting history item.
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
59 - **Column for x axis** - only numerical columns are possible.
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
60 - **Number of breaks(bars)** - breakpoints between histogram cells. Value of '0' will determine breaks automatically.
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
61 - **Plot title** - the histogram title.
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
62 - **Label for x axis** - the label of the x axis for the histogram.
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
63 - **Include smoothed density** - if checked, the resulting graph will join the given corresponding points with line segments.
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
64
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
65 -----
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
66
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
67 **Example**
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
68
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
69 - Input file::
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
70
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
71 1 68 4.1
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
72 2 71 4.6
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
73 3 62 3.8
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
74 4 75 4.4
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
75 5 58 3.2
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
76 6 60 3.1
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
77 7 67 3.8
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
78 8 68 4.1
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
79 9 71 4.3
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
80 10 69 3.7
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
81
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
82 - Create a histogram on column 2 of the above dataset.
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
83
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
84 .. image:: histogram2.png
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
85
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
86 </help>
f4e143b7eb06 Imported from capsule None
devteam
parents:
diff changeset
87 </tool>