annotate plot_res.xml @ 0:e7cd19afda2e draft

Lefse
author george-weingart
date Tue, 13 May 2014 21:57:00 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
george-weingart
parents:
diff changeset
1 <tool id="LEfSe_res" name="C) Plot LEfSe Results" version="1.0">
george-weingart
parents:
diff changeset
2 <description></description>
george-weingart
parents:
diff changeset
3 <command interpreter="python">./plot_res.py $inp_data $res --title "$textm.title" --subclades $textm.subclades --title_font_size $textm.title_font_size --max_feature_len $textm.max_f_len --feature_font_size $textm.feature_font_size --class_legend_font_size $textm.class_legend_font_size --width $graphical.width --format $for --dpi $dpi --left_space $graphical.left_space_prop --right_space $graphical.right_space_prop --background_color $graphical.background_color</command>
george-weingart
parents:
diff changeset
4 <inputs>
george-weingart
parents:
diff changeset
5 <page>
george-weingart
parents:
diff changeset
6 <param format="lefse_res" name="inp_data" type="data" label="Select data" help=""/>
george-weingart
parents:
diff changeset
7
george-weingart
parents:
diff changeset
8 <conditional name="textm">
george-weingart
parents:
diff changeset
9 <param name="text_choice" type="select" label="Set text and label options (font size, abbreviations, ...)" help="">
george-weingart
parents:
diff changeset
10 <option value="d" selected='True'>Default</option>
george-weingart
parents:
diff changeset
11 <option value="a">Advanced</option>
george-weingart
parents:
diff changeset
12 </param>
george-weingart
parents:
diff changeset
13 <when value="d">
george-weingart
parents:
diff changeset
14 <param name="title" type="hidden" value=""/>
george-weingart
parents:
diff changeset
15 <param name="title_font_size" type="hidden" value="14"/>
george-weingart
parents:
diff changeset
16 <param name="feature_font_size" type="hidden" value="7" />
george-weingart
parents:
diff changeset
17 <param name="class_legend_font_size" type="hidden" value="10" />
george-weingart
parents:
diff changeset
18 <param name="subclades" type="hidden" value="1" />
george-weingart
parents:
diff changeset
19 <param name="max_f_len" type="hidden" value="60" />
george-weingart
parents:
diff changeset
20 </when>
george-weingart
parents:
diff changeset
21 <when value="a">
george-weingart
parents:
diff changeset
22 <param name="title" type="text" size="10" value="" label="The title of the cladogram"/>
george-weingart
parents:
diff changeset
23 <param name="subclades" type="integer" size="2" value="1" label="Number of label levels to be displayed (-1 means all)"/>
george-weingart
parents:
diff changeset
24 <param name="max_f_len" type="integer" size="2" value="60" label="Maximum length of feature names "/>
george-weingart
parents:
diff changeset
25 <param name="title_font_size" type="integer" size="2" value="14" label="Title font size"/>
george-weingart
parents:
diff changeset
26 <param name="feature_font_size" type="integer" size="2" value="7" label="Label font size"/>
george-weingart
parents:
diff changeset
27 <param name="class_legend_font_size" type="integer" size="2" value="10" label="Class font size"/>
george-weingart
parents:
diff changeset
28 </when>
george-weingart
parents:
diff changeset
29 </conditional>
george-weingart
parents:
diff changeset
30
george-weingart
parents:
diff changeset
31 <conditional name="graphical">
george-weingart
parents:
diff changeset
32 <param name="text_choice" type="select" label="Set some graphical options to personalize the output" help="">
george-weingart
parents:
diff changeset
33 <option value="d" selected='True'>Default</option>
george-weingart
parents:
diff changeset
34 <option value="a">Advanced</option>
george-weingart
parents:
diff changeset
35 </param>
george-weingart
parents:
diff changeset
36 <when value="d">
george-weingart
parents:
diff changeset
37 <param name="width" type="hidden" value="7.0" />
george-weingart
parents:
diff changeset
38 <param name="left_space_prop" type="hidden" value="0.2" />
george-weingart
parents:
diff changeset
39 <param name="right_space_prop" type="hidden" value="0.1" />
george-weingart
parents:
diff changeset
40 <param name="background_color" type="hidden" value="w"/>
george-weingart
parents:
diff changeset
41 </when>
george-weingart
parents:
diff changeset
42 <when value="a">
george-weingart
parents:
diff changeset
43 <param name="width" type="float" size="2" value="7.0" label="Width of the plot"/>
george-weingart
parents:
diff changeset
44 <param name="left_space_prop" type="float" size="2" value="0.2" label="Fraction of the total width to be reserved for the space at the left of the plot "/>
george-weingart
parents:
diff changeset
45 <param name="right_space_prop" type="float" size="2" value="0.1" label="Fraction of the total width to be reserved for the space at the right of the plot "/>
george-weingart
parents:
diff changeset
46 <param name="background_color" type="select" label="Whether to optimize the colors for a white or black background">
george-weingart
parents:
diff changeset
47 <option value="w" selected='True'>White</option>
george-weingart
parents:
diff changeset
48 <option value="k">Black</option>
george-weingart
parents:
diff changeset
49 </param>
george-weingart
parents:
diff changeset
50
george-weingart
parents:
diff changeset
51 </when>
george-weingart
parents:
diff changeset
52 </conditional>
george-weingart
parents:
diff changeset
53
george-weingart
parents:
diff changeset
54
george-weingart
parents:
diff changeset
55
george-weingart
parents:
diff changeset
56 <param name="for" type="select" label="Output format">
george-weingart
parents:
diff changeset
57 <option value="png" selected="png">png</option>
george-weingart
parents:
diff changeset
58 <option value="svg">svg</option>
george-weingart
parents:
diff changeset
59 <option value="pdf">pdf</option>
george-weingart
parents:
diff changeset
60 </param>
george-weingart
parents:
diff changeset
61 <param name="dpi" type="select" label="Set the dpi resolution of the output">
george-weingart
parents:
diff changeset
62 <option value="72">72</option>
george-weingart
parents:
diff changeset
63 <option value="150" selected="True">150</option>
george-weingart
parents:
diff changeset
64 <option value="300">300</option>
george-weingart
parents:
diff changeset
65 <option value="600">600</option>
george-weingart
parents:
diff changeset
66 <option value="1200">1200</option>
george-weingart
parents:
diff changeset
67 </param>
george-weingart
parents:
diff changeset
68
george-weingart
parents:
diff changeset
69 </page>
george-weingart
parents:
diff changeset
70 </inputs>
george-weingart
parents:
diff changeset
71 <outputs>
george-weingart
parents:
diff changeset
72 <data format="png" name="res" >
george-weingart
parents:
diff changeset
73 <change_format>
george-weingart
parents:
diff changeset
74 <when input="for" value="svg" format="svg" />
george-weingart
parents:
diff changeset
75 </change_format>
george-weingart
parents:
diff changeset
76 </data>
george-weingart
parents:
diff changeset
77 </outputs>
george-weingart
parents:
diff changeset
78 <tests>
george-weingart
parents:
diff changeset
79 <test>
george-weingart
parents:
diff changeset
80 <param name="input1" value="13.bed" dbkey="hg18" ftype="bed"/>
george-weingart
parents:
diff changeset
81 <param name="maf_source" value="cached"/>
george-weingart
parents:
diff changeset
82 <param name="maf_identifier" value="17_WAY_MULTIZ_hg18"/>
george-weingart
parents:
diff changeset
83 <param name="species" value="hg18,mm8"/>
george-weingart
parents:
diff changeset
84 <param name="overwrite_with_gaps" value="True"/>
george-weingart
parents:
diff changeset
85 <output name="out_file1" file="interval_maf_to_merged_fasta_out3.fasta" />
george-weingart
parents:
diff changeset
86 </test>
george-weingart
parents:
diff changeset
87 <test>
george-weingart
parents:
diff changeset
88 <param name="input1" value="1.bed" dbkey="hg17" ftype="bed"/>
george-weingart
parents:
diff changeset
89 <param name="maf_source" value="cached"/>
george-weingart
parents:
diff changeset
90 <param name="maf_identifier" value="8_WAY_MULTIZ_hg17"/>
george-weingart
parents:
diff changeset
91 <param name="species" value="canFam1,hg17,mm5,panTro1,rn3"/>
george-weingart
parents:
diff changeset
92 <param name="overwrite_with_gaps" value="True"/>
george-weingart
parents:
diff changeset
93 <output name="out_file1" file="interval_maf_to_merged_fasta_out.dat" />
george-weingart
parents:
diff changeset
94 </test>
george-weingart
parents:
diff changeset
95 <test>
george-weingart
parents:
diff changeset
96 <param name="input1" value="1.bed" dbkey="hg17" ftype="bed"/>
george-weingart
parents:
diff changeset
97 <param name="maf_source" value="user"/>
george-weingart
parents:
diff changeset
98 <param name="maf_file" value="5.maf"/>
george-weingart
parents:
diff changeset
99 <param name="species" value="canFam1,hg17,mm5,panTro1,rn3"/>
george-weingart
parents:
diff changeset
100 <param name="overwrite_with_gaps" value="True"/>
george-weingart
parents:
diff changeset
101 <output name="out_file1" file="interval_maf_to_merged_fasta_user_out.dat" />
george-weingart
parents:
diff changeset
102 </test>
george-weingart
parents:
diff changeset
103 </tests>
george-weingart
parents:
diff changeset
104 <help>
george-weingart
parents:
diff changeset
105 **What it does**
george-weingart
parents:
diff changeset
106
george-weingart
parents:
diff changeset
107 This module plots the biomarkers found by LEfSe ranking them accordingly to their effect size and associating them with the class with the highest median.
george-weingart
parents:
diff changeset
108
george-weingart
parents:
diff changeset
109 ------
george-weingart
parents:
diff changeset
110
george-weingart
parents:
diff changeset
111 **Input format**
george-weingart
parents:
diff changeset
112
george-weingart
parents:
diff changeset
113 The module accepts the output of the LEfSe module (B) only.
george-weingart
parents:
diff changeset
114
george-weingart
parents:
diff changeset
115 ------
george-weingart
parents:
diff changeset
116
george-weingart
parents:
diff changeset
117 **Output format**
george-weingart
parents:
diff changeset
118
george-weingart
parents:
diff changeset
119 The module generate images in png, svg or pdf format. The png format is recommended for exploratory runs as it can be easily visualized internally in Galaxy, whereas the vectorial svg and pdf formats are recommended for the final publication-ready image to be downloaded.
george-weingart
parents:
diff changeset
120
george-weingart
parents:
diff changeset
121 ------
george-weingart
parents:
diff changeset
122
george-weingart
parents:
diff changeset
123 **Parameters**
george-weingart
parents:
diff changeset
124
george-weingart
parents:
diff changeset
125 In addition to the output format and the dpi resolution two sets of parameters can be tuned: text and label options for regulating the plot annotation and graphical options for personalizing the appearance of the plot. The default settings of the parameters should give satisfactory outputs in the great majority of the cases.
george-weingart
parents:
diff changeset
126
george-weingart
parents:
diff changeset
127 **Advanced parameter settings**
george-weingart
parents:
diff changeset
128
george-weingart
parents:
diff changeset
129 *Text and label options*
george-weingart
parents:
diff changeset
130 * The title of the cladogram: optional title for the plot (default is no title).
george-weingart
parents:
diff changeset
131 * Number of label levels to be displayed: when dealing with hierarchical features this option sets the level to be displayed in the labels (-1 means the last level only, 1 means the highest level, 2 means the first two levels and so on).
george-weingart
parents:
diff changeset
132 * Maximum length of feature names: set the length of the feature names above which the names will be abbreviated (in the middle of the string).
george-weingart
parents:
diff changeset
133 * Title font size: set the font size of the title only.
george-weingart
parents:
diff changeset
134 * Label font size: set the font size of the labels (and of the label legend) used in the cladogram to denote taxa.
george-weingart
parents:
diff changeset
135 * Class font size: set the font of the legend for the class names and colors.
george-weingart
parents:
diff changeset
136 *Graphical options*
george-weingart
parents:
diff changeset
137 * Width of the plot: set the inches for the width of the plot (the height is automatically set based on the number of biomarkers to be displayed).
george-weingart
parents:
diff changeset
138 * Fraction of the total width to be reserved for the space at the left of the plot: this option permits the user to enlarge the space on the left of the plot for the cases in which the feature labels are long and need more space.
george-weingart
parents:
diff changeset
139 * Fraction of the total width to be reserved for the space at the right of the plot: this option permits the user to enlarge the space on the right of the plot for the cases in which the feature labels are long and need more space.
george-weingart
parents:
diff changeset
140 * Whether to optimize the colors for a white or black background: this option permits the user to generate output plots with black backgrounds, adjusting properly the colors of the cladogram.
george-weingart
parents:
diff changeset
141
george-weingart
parents:
diff changeset
142
george-weingart
parents:
diff changeset
143 ------
george-weingart
parents:
diff changeset
144
george-weingart
parents:
diff changeset
145 **Example**
george-weingart
parents:
diff changeset
146
george-weingart
parents:
diff changeset
147 The dataset provided here_ and described in the "Introduction" module produces the following image (alpha values of LEfSe - step B - are set to 0.01)
george-weingart
parents:
diff changeset
148
george-weingart
parents:
diff changeset
149 .. image:: ../galaxy/static/images/plot_res_ex.png
george-weingart
parents:
diff changeset
150 .. _here: http://www.huttenhower.org/webfm_send/73
george-weingart
parents:
diff changeset
151
george-weingart
parents:
diff changeset
152
george-weingart
parents:
diff changeset
153
george-weingart
parents:
diff changeset
154
george-weingart
parents:
diff changeset
155 </help>
george-weingart
parents:
diff changeset
156 </tool>