annotate draw_stacked_barplots.xml @ 1:719648a1e3af draft default tip

Uploaded tool help image.
author devteam
date Tue, 03 Jun 2014 14:47:39 -0400
parents d1412b13879d
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
1 <tool id="draw_stacked_barplots" name="Draw Stacked Bar Plots" version="1.0.0">
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
2 <description>for different categories and different criteria</description>
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
3 <requirements>
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
4 <requirement type="package" version="2.11.0">R</requirement>
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
5 </requirements>
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
6 <command interpreter="perl">
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
7 draw_stacked_barplots.pl $inputFile1 $outputFile1
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
8 </command>
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
9
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
10 <inputs>
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
11 <param format="tabular" name="inputFile1" type="data" label="Select the input file"/>
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
12 </inputs>
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
13
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
14 <outputs>
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
15 <data format="pdf" name="outputFile1"/>
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
16 </outputs>
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
17
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
18 <tests>
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
19 <test>
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
20 <param name="inputFile1" value="categories_criteria.tabular" />
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
21 <output name="outputFile1" file="stacked_barplot.pdf" />
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
22 </test>
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
23 </tests>
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
24
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
25 <help>
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
26
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
27 .. class:: infomark
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
28
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
29 **What it does**
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
30
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
31 This program draws, in a pdf file, a stacked bars plot for different categories of data and for different criteria. For each criterion a stacked bar is
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
32 drawn, such that the height of each stacked sub-bar represents the number of elements in each category satisfying that criterion.
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
33
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
34 - The input consists of a TABULAR format file, where the left column represents the names of categories and the other columns are headed by the names of criteria, such that each data value in the file represents the number of elements in a certain category satisfying a certain criterion:
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
35
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
36 - The output is a PDF file containing a stacked bars plot representing the number of elements in each category satisfying each criterion. The drawing is done using R code.
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
37
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
38 **Example**
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
39
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
40 Let us suppose that the input file represent the number of significant motifs in each motif category for each window size::
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
41
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
42 10bp 20bp 40bp 80bp 160bp 320bp 640bp 1280bp
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
43 Deletion_Hotspots 2 3 4 4 5 6 7 7
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
44 Dna_Pol_Pause/Frameshift_Hotspots 8 10 14 17 18 15 19 20
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
45 Indel_Hotspots 1 1 1 2 1 0 0 0
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
46 Insertion_Hotspots 0 0 1 2 2 2 2 5
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
47 Topoisomerase_Cleavage_Sites 2 3 5 4 3 3 4 4
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
48 Translin_Targets 0 0 2 2 3 3 3 2
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
49 VDJ_Recombination_Signals 0 0 1 1 1 2 2 2
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
50 X-like_Sites 4 4 4 5 6 7 7 10
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
51
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
52
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
53 Runnig the program will give the following output::
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
54
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
55 The stacked bars plot representing the data in the input file.
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
56
1
719648a1e3af Uploaded tool help image.
devteam
parents: 0
diff changeset
57 .. image:: stacked_bars_plot.png
0
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
58
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
59 </help>
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
60
d1412b13879d Uploaded tool tarball.
devteam
parents:
diff changeset
61 </tool>