annotate home/ubuntu/lefse_to_export/plot_features.xml @ 2:a31c10fe09c8 draft default tip

Fixed bug due to numerical approximation after normalization affecting root-level clades (e.g. "Bacteria" or "Archaea")
author george-weingart
date Tue, 07 Jul 2015 13:52:29 -0400
parents db64b6287cd6
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
1 <tool id="LEfSe_fea" name="F) Plot Differential Features" version="1.0">
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
2 <description></description>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
3 <command interpreter="python">plot_features.py $inp_data $inp_res $arch --title_font_size $graphical.title_font_size --background_color $graphical.background_color --class_label_pos $graphical.class_label_pos --class_font_size $graphical.class_font_size --top $graphical.top --bot $graphical.bot --font_size $graphical.font_size --width $graphical.width --height $graphical.height -f $feature_set --archive "zip" --format $for --dpi $dpi --subcl_mean $graphical.subcl_mean --subcl_median $graphical.subcl_median </command>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
4 <inputs>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
5 <page>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
6 <param format="lefse_internal_for" name="inp_data" type="data" label="The formatted datasets" help=""/>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
7 <param format="lefse_internal_res" name="inp_res" type="data" label="The LEfSe output" help=""/>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
8
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
9 <param name="feature_set" type="select" label="Do you want to plot all features or only those detected as biomarkers?">
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
10 <option value="diff" selected="diff">Biomarkers only</option>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
11 <option value="all">All</option>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
12 </param>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
13
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
14
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
15 <conditional name="graphical">
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
16 <param name="graphical_choice" type="select" label="Set some graphical options to personalize the output">
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
17 <option value="d" selected='True'>Default</option>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
18 <option value="a">Advanced</option>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
19 </param>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
20 <when value="d">
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
21 <param name="top" type="hidden" value="-1.0" />
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
22 <param name="bot" type="hidden" value="0.0" />
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
23 <param name="title_font_size" type="hidden" value="14" />
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
24 <param name="class_font_size" type="hidden" value="12" />
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
25 <param name="font_size" type="hidden" value="8" />
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
26 <param name="width" type="hidden" value="7.0" />
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
27 <param name="height" type="hidden" value="4.0" />
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
28 <param name="background_color" type="hidden" value="w" />
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
29 <param name="width" type="hidden" value="7.0" />
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
30 <param name="height" type="hidden" value="4.0" />
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
31 <param name="class_label_pos" type="hidden" value="up" />
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
32 <param name="subcl_mean" type="hidden" value="y" />
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
33 <param name="subcl_median" type="hidden" value="y" />
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
34 </when>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
35
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
36 <when value="a">
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
37 <param name="top" type="float" size="2" value="-1.0" label="Set the maximum y value (-1.0 means automatic maximum setting based on maximum class median)"/>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
38 <param name="bot" type="float" size="2" value="0.0" label="Set the minimum y value (-1.0 means automatic minimum setting based on minimum class median)"/>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
39 <param name="title_font_size" type="integer" size="2" value="14" label="Title font size"/>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
40 <param name="class_font_size" type="integer" size="2" value="12" label="Class font size"/>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
41 <param name="font_size" type="integer" size="2" value="8" label="Size of subclasses names and y values"/>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
42 <param name="width" type="float" size="2" value="7.0" label="Width of the plot"/>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
43 <param name="height" type="float" size="2" value="4.0" label="Height of the plot"/>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
44 <param name="background_color" type="select" label="Background color">
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
45 <option value="w" selected='True'>White</option>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
46 <option value="k">Black</option>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
47 </param>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
48 <param name="class_label_pos" type="select" label="Class label position">
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
49 <option value="up" selected='True'>Top</option>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
50 <option value="down">Bottom</option>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
51 </param>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
52 <param name="subcl_mean" type="select" label="Whether to plot the subclass means (straight line)">
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
53 <option value="y" selected='True'>Yes</option>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
54 <option value="n">No</option>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
55 </param>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
56 <param name="subcl_median" type="select" label="Whether to plot the subclass medians (dotted line)">
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
57 <option value="y" selected='True'>Yes</option>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
58 <option value="n">No</option>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
59 </param>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
60
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
61 </when>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
62
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
63 </conditional>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
64
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
65 <param name="for" type="select" label="Output format">
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
66 <option value="png" selected="png">png</option>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
67 <option value="svg">svg</option>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
68 <option value="pdf">pdf</option>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
69 </param>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
70 <param name="dpi" type="select" label="Set the dpi resolution of the output">
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
71 <option value="72">72</option>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
72 <option value="150" selected="True">150</option>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
73 <option value="300">300</option>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
74 <option value="600">600</option>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
75 <option value="1200">1200</option>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
76 </param>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
77
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
78 </page>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
79 </inputs>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
80 <outputs>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
81 <data format="zip" name="arch" >
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
82 </data>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
83 </outputs>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
84 <tests>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
85 <test>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
86 <param name="input1" value="13.bed" dbkey="hg18" ftype="bed"/>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
87 <param name="maf_source" value="cached"/>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
88 <param name="maf_identifier" value="17_WAY_MULTIZ_hg18"/>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
89 <param name="species" value="hg18,mm8"/>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
90 <param name="overwrite_with_gaps" value="True"/>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
91 <output name="out_file1" file="interval_maf_to_merged_fasta_out3.fasta" />
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
92 </test>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
93 <test>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
94 <param name="input1" value="1.bed" dbkey="hg17" ftype="bed"/>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
95 <param name="maf_source" value="cached"/>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
96 <param name="maf_identifier" value="8_WAY_MULTIZ_hg17"/>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
97 <param name="species" value="canFam1,hg17,mm5,panTro1,rn3"/>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
98 <param name="overwrite_with_gaps" value="True"/>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
99 <output name="out_file1" file="interval_maf_to_merged_fasta_out.dat" />
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
100 </test>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
101 <test>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
102 <param name="input1" value="1.bed" dbkey="hg17" ftype="bed"/>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
103 <param name="maf_source" value="user"/>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
104 <param name="maf_file" value="5.maf"/>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
105 <param name="species" value="canFam1,hg17,mm5,panTro1,rn3"/>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
106 <param name="overwrite_with_gaps" value="True"/>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
107 <output name="out_file1" file="interval_maf_to_merged_fasta_user_out.dat" />
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
108 </test>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
109 </tests>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
110 <help>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
111 **What it does**
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
112
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
113 This module plots the raw data of the features detected by LEfSe as biomarkers as abundance histograms
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
114 with class and subclass information. The features are exported as images and
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
115 the user can download all the images in a .zip archive. It is also possible to
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
116 export all the features (instead of the biomarkers only). For exporting or
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
117 analyzing few features only the "Plot One Feature" module is recommended.
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
118
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
119 ------
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
120
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
121 **Input format**
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
122
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
123 The module accepts two datasets: the data formatted with the "Format Input for
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
124 LEfSe" module and the output of the LEfSe analysis. Both datasets are necessary
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
125 to run the module.
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
126
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
127 ------
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
128
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
129 **Output format**
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
130
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
131 The module generates zip archives containing images in png, svg or pdf format.
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
132
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
133 ------
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
134
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
135 **Advanced parameter settings**
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
136
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
137 *Graphical options*
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
138 * Set the maximum y value: -1 means automatic parameter setting that is computed as the minimum between the highest abundance value and three times the highest subclass median.
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
139 * Set the minimum y value: -1 means automatic parameter setting that is computed as the maximum between 0 and the 90% of the smallest abundance value.
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
140 * Title font size: set the font size of the title only.
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
141 * Class font size: set the font of the legend for the class names and colors.
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
142 * Size of subclasses names and y values: set the font size for the axis labels.
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
143 * Width of the plot: horizontal size (in inches) of the plot.
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
144 * Height of the plot: vertical size (in inches) of the plot.
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
145 * Background color: whether to generate plots with black or white backgrounds, adjusting properly the other colors.
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
146 * Class label position: whether to place the class labels on the top or on the bottom of the plot.
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
147 * Plot subclass means (straight line): whether to plot the subclass means with straight horizontal lines.
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
148 * Plot subclass medians (dotted line): whether to plot the subclass medians with dotted horizontal lines.
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
149
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
150 ------
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
151
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
152 **Examples**
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
153
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
154 Please see the examples reported for the "Plot One Feature" module (E). This
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
155 module just produces multiple plots in the same way and compresses them into a
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
156 .zip archive.
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
157
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
158 </help>
db64b6287cd6 Modified datatypes
george-weingart
parents:
diff changeset
159 </tool>