Mercurial > repos > devteam > histogram
annotate histogram2.xml @ 2:4d2c30376614 draft
"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 | 7bd40c4d7df7 |
| 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 | 2 <description>of a numeric column</description> |
| 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 | 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 | 18 <inputs> |
| 19 <param name="input" type="data" format="tabular" label="Dataset" help="Dataset missing? See TIP below"/> | |
| 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 | 24 <param name="density" type="boolean" checked="yes" label="Include smoothed density"/> |
| 25 <param name="frequency" type="boolean" checked="no" label="Plot as frequency (counts)"/> | |
| 26 </inputs> | |
| 27 <outputs> | |
| 28 <data format="pdf" name="out_file1" /> | |
| 29 </outputs> | |
| 30 <tests> | |
| 31 <test> | |
| 32 <param name="input" value="histogram_in1.tabular" ftype="tabular"/> | |
| 33 <param name="numerical_column" value="2"/> | |
| 34 <param name="breaks" value="0"/> | |
| 35 <param name="title" value="Histogram"/> | |
| 36 <param name="xlab" value="V1"/> | |
| 37 <param name="density" value="true"/> | |
| 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 | 40 </test> |
| 41 </tests> | |
| 42 <help> | |
| 43 | |
| 44 .. class:: infomark | |
| 45 | |
| 46 **TIP:** To remove comment lines that do not begin with a *#* character, use *Text Manipulation->Remove beginning* | |
| 47 | |
| 48 .. class:: infomark | |
| 49 | |
| 50 **TIP:** If your data is not TAB delimited, use *Text Manipulation->Convert* | |
| 51 | |
| 52 ----- | |
| 53 | |
| 54 **Syntax** | |
| 55 | |
| 56 This tool computes a histogram of the numerical values in a column of a dataset. | |
| 57 | |
| 58 - All invalid, blank and comment lines in the dataset are skipped. The number of skipped lines is displayed in the resulting history item. | |
| 59 - **Column for x axis** - only numerical columns are possible. | |
| 60 - **Number of breaks(bars)** - breakpoints between histogram cells. Value of '0' will determine breaks automatically. | |
| 61 - **Plot title** - the histogram title. | |
| 62 - **Label for x axis** - the label of the x axis for the histogram. | |
| 63 - **Include smoothed density** - if checked, the resulting graph will join the given corresponding points with line segments. | |
| 64 | |
| 65 ----- | |
| 66 | |
| 67 **Example** | |
| 68 | |
| 69 - Input file:: | |
| 70 | |
| 71 1 68 4.1 | |
| 72 2 71 4.6 | |
| 73 3 62 3.8 | |
| 74 4 75 4.4 | |
| 75 5 58 3.2 | |
| 76 6 60 3.1 | |
| 77 7 67 3.8 | |
| 78 8 68 4.1 | |
| 79 9 71 4.3 | |
| 80 10 69 3.7 | |
| 81 | |
| 82 - Create a histogram on column 2 of the above dataset. | |
| 83 | |
| 84 .. image:: histogram2.png | |
| 85 | |
| 86 </help> | |
| 87 </tool> |
