|
0
|
1 <tool id="export2graphlan" name="export2graphlan" version="1.0.0">
|
|
|
2 <description>Export to Graphlan</description>
|
|
|
3 <command interpreter="python">
|
|
|
4 export2graphlan.py
|
|
|
5 -i $inp_data
|
|
|
6 -o $out_data
|
|
|
7 -t $output_tree_file
|
|
|
8 -a $output_annot_file
|
|
18
|
9
|
|
0
|
10 --annotations $export_annotations
|
|
|
11 --external_annotations $export_external_annotations
|
|
14
|
12 --background_levels $background_levels
|
|
17
|
13 #if $str($background_clades) != " ":
|
|
16
|
14 --background_clades $background_clades
|
|
|
15 #end if
|
|
18
|
16 #if $str($background_colors) != " ":
|
|
|
17 --background_colors $background_colors
|
|
|
18 #end if
|
|
|
19 #if $str($export_title) != " ":
|
|
|
20 --title $export_title
|
|
|
21 #end if
|
|
|
22 --title_font_size $title_font_size
|
|
|
23 --def_clade_size $def_clade_size
|
|
|
24 --min_clade_size $min_clade_size
|
|
|
25 --max_clade_size $max_clade_size
|
|
0
|
26 --skip_rows 1,2
|
|
|
27 </command>
|
|
|
28
|
|
|
29 <inputs>
|
|
19
|
30 <param format="tabular" name="inp_data" type="data" label="Input used to run Lefse" help="This is the file that was used as input for Lefse"/>
|
|
|
31 <param format="lefse_internal_res" name="out_data" type="data" label="Output of Lefse" help="This is the Lefse output file"/>
|
|
14
|
32 <param name="export_annotations" type="text" format="text" label="Annotations" value="2,3"/>
|
|
|
33 <param name="export_external_annotations" type="text" format="text" label="External Annotations" value="4,5,6"/>
|
|
|
34 <param name="background_levels" type="text" format="text" label="Background Levels" value="1,2,3"/>
|
|
15
|
35 <param name="background_clades" type="text" format="text" label="Background Clades" value=" " />
|
|
18
|
36 <param name="background_colors" type="text" format="text" label="Background Colors" value=" " />
|
|
|
37 <param name="export_title" type="text" format="text" label="Title" value=" "/>
|
|
|
38 <param name="title_font_size" type="integer" size="4" value="15" label="Title font size"/>
|
|
|
39 <param name="def_clade_size" type="integer" size="4" value="0" label="Default Clade size"/>
|
|
|
40 <param name="min_clade_size" type="integer" size="4" value="20" label="Minimum Clade size that are Biomarkers"/>
|
|
|
41 <param name="max_clade_size" type="integer" size="4" value="200" label="Maximum Clade size that are Biomarkers"/>
|
|
14
|
42
|
|
0
|
43 </inputs>
|
|
|
44 <outputs>
|
|
|
45 <data name="output_annot_file" format="circl" />
|
|
|
46 <data name="output_tree_file" format="circl" />
|
|
|
47 </outputs>
|
|
|
48
|
|
|
49 <help>
|
|
|
50 Overview
|
|
|
51 ========
|
|
1
|
52 **export2graphlan** is an *OPTIONAL* tool that automatically convert **LEfSe**, **MetaPhlAn2**, and **HUMAnN** input and/or output files, to **GraPhlAn**. Input file can be also given in BIOM (both 1 and 2) format.
|
|
0
|
53
|
|
1
|
54 The aim of this tool is to support biologists, helping them by provide the tree and the annotation file for GraPhlAn, automatically.
|
|
|
55
|
|
|
56 Input files
|
|
|
57 -----------
|
|
|
58
|
|
|
59 As shown in the image below, export2graphlan can work with just one of the following files or with both of them.
|
|
|
60
|
|
|
61 * **Result of MetaPhlAn or HUMAnN analysis**: As depicted in the image below, this file can be the result of a MetaPhlAn analysis or a HUMAnN analysis. Generally, it is a tab separated file that have for each row a taxonomy and an abundance value.
|
|
|
62
|
|
|
63 * **Output of LEfSe**: This file is the result of LEfSe execute on the *Result of MetaPhlAn or HUMAnN analysis* file. This file allow GraPhlAn to highlight for you the found biomarkers.
|
|
|
64
|
|
18
|
65 Input parameters6666
|
|
4
|
66 --------------------
|
|
3
|
67
|
|
4
|
68 --annotations ANNOTATIONS
|
|
1
|
69 List which levels should be annotated in the tree. Use
|
|
|
70 a comma separate values form, e.g.,
|
|
|
71 --annotation_levels 1,2,3. Default is None
|
|
4
|
72 --external_annotations EXTERNAL_ANNOTATIONS
|
|
1
|
73 List which levels should use the external legend for
|
|
|
74 the annotation. Use a comma separate values form,
|
|
|
75 e.g., --annotation_levels 1,2,3. Default is None
|
|
|
76 --background_levels BACKGROUND_LEVELS
|
|
|
77 List which levels should be highlight with a shaded
|
|
|
78 background. Use a comma separate values form, e.g.,
|
|
|
79 --background_levels 1,2,3
|
|
|
80 --background_clades BACKGROUND_CLADES
|
|
|
81 Specify the clades that should be highlight with a
|
|
|
82 shaded background. Use a comma separate values form
|
|
|
83 and surround the string with " if it contains spaces.
|
|
|
84 Example: --background_clades "Bacteria.Actinobacteria,
|
|
|
85 Bacteria.Bacteroidetes.Bacteroidia,
|
|
|
86 Bacteria.Firmicutes.Clostridia.Clostridiales"
|
|
|
87 --background_colors BACKGROUND_COLORS
|
|
|
88 Set the color to use for the shaded background. Colors
|
|
|
89 can be either in RGB or HSV (using a semi-colon to
|
|
|
90 separate values, surrounded with ()) format. Use a
|
|
|
91 comma separate values form and surround the string
|
|
|
92 with " if it contains spaces. Example:
|
|
|
93 --background_colors "#29cc36, (150; 100; 100), (280;
|
|
|
94 80; 88)"
|
|
|
95 --title TITLE If specified set the title of the GraPhlAn plot.
|
|
|
96 Surround the string with " if it contains spaces,
|
|
|
97 e.g., --title "Title example"
|
|
|
98 --title_font_size TITLE_FONT_SIZE
|
|
|
99 Set the title font size. Default is 15
|
|
|
100 --def_clade_size DEF_CLADE_SIZE
|
|
|
101 Set a default size for clades that are not found as
|
|
|
102 biomarkers by LEfSe. Default is 10
|
|
|
103 --min_clade_size MIN_CLADE_SIZE
|
|
|
104 Set the minimum value of clades that are biomarkers.
|
|
|
105 Default is 20
|
|
|
106 --max_clade_size MAX_CLADE_SIZE
|
|
|
107 Set the maximum value of clades that are biomarkers.
|
|
|
108 Default is 200
|
|
|
109 --def_font_size DEF_FONT_SIZE
|
|
|
110 Set a default font size. Default is 10
|
|
|
111 --min_font_size MIN_FONT_SIZE
|
|
|
112 Set the minimum font size to use. Default is 8
|
|
|
113 --max_font_size MAX_FONT_SIZE
|
|
|
114 Set the maximum font size. Default is 12
|
|
|
115 --annotation_legend_font_size ANNOTATION_LEGEND_FONT_SIZE
|
|
|
116 Set the font size for the annotation legend. Default
|
|
|
117 is 10
|
|
|
118 --abundance_threshold ABUNDANCE_THRESHOLD
|
|
|
119 Set the minimun abundace value for a clade to be
|
|
|
120 annotated. Default is 20.0
|
|
|
121 --most_abundant MOST_ABUNDANT
|
|
|
122 When only lefse_input is provided, you can specify how
|
|
|
123 many clades highlight. Since the biomarkers are
|
|
|
124 missing, they will be chosen from the most abundant
|
|
|
125 --least_biomarkers LEAST_BIOMARKERS
|
|
|
126 When only lefse_input is provided, you can specify the
|
|
|
127 minimum number of biomarkers to extract. The taxonomy
|
|
|
128 is parsed, and the level is choosen in order to have
|
|
|
129 at least the specified number of biomarkers
|
|
|
130 --discard_otus If specified the OTU ids will be discarde from the
|
|
|
131 taxonmy. Default behavior keep OTU ids in taxonomy
|
|
|
132 --internal_levels If specified sum-up from leaf to root the abundances
|
|
|
133 values. Default behavior do not sum-up abundances on
|
|
|
134 the internal nodes
|
|
|
135
|
|
|
136 input parameters:
|
|
6
|
137 You need to provide at least LEfSe input data
|
|
3
|
138 -i LEFSE_INPUT, --lefse_input LEFSE_INPUT
|
|
6
|
139
|
|
1
|
140 -o LEFSE_OUTPUT, --lefse_output LEFSE_OUTPUT
|
|
|
141
|
|
|
142 output parameters:
|
|
13
|
143
|
|
1
|
144 -t TREE, --tree TREE Output filename where save the input tree for GraPhlAn
|
|
13
|
145
|
|
9
|
146 -a ANNOTATION, --annotation ANNOTATION : This is the Output filename where to save GraPhlAn annotation
|
|
7
|
147
|
|
1
|
148 Input data matrix parameters:
|
|
|
149 --sep SEP
|
|
9
|
150 --out_table OUT_TABLE : This is where to write the processed data matrix to file
|
|
12
|
151
|
|
11
|
152 --fname_row FNAME_ROW : Row number containing the names of the features (default 0, specify -1 if no names are present in the matrix)
|
|
12
|
153
|
|
1
|
154 --sname_row SNAME_ROW
|
|
11
|
155 column number containing the names of the samples (default 0, specify -1 if no names are present in the matrix)
|
|
1
|
156 --metadata_rows METADATA_ROWS
|
|
|
157 Row numbers to use as metadata[default None, meaning
|
|
|
158 no metadata
|
|
|
159 --skip_rows SKIP_ROWS
|
|
|
160 Row numbers to skip (0-indexed, comma separated) from
|
|
|
161 the input file[default None, meaning no rows skipped
|
|
|
162 --sperc SPERC Percentile of sample value distribution for sample
|
|
|
163 selection
|
|
|
164 --fperc FPERC Percentile of feature value distribution for sample
|
|
|
165 selection
|
|
|
166 --stop STOP Number of top samples to select (ordering based on
|
|
|
167 percentile specified by --sperc)
|
|
|
168 --ftop FTOP Number of top features to select (ordering based on
|
|
|
169 percentile specified by --fperc)
|
|
|
170 --def_na DEF_NA Set the default value for missing values [default None
|
|
|
171 which means no replacement]
|
|
|
172
|
|
|
173 Integration
|
|
|
174 ===========
|
|
|
175
|
|
|
176 A graphical representation of how **export2graphlan** can be integrated in the analysis pipeline:
|
|
0
|
177
|
|
|
178 .. image:: https://bitbucket.org/repo/oL6bEG/images/3364692296-graphlan_integration.png
|
|
1
|
179 :height: 672
|
|
|
180 :width: 800
|
|
0
|
181
|
|
1
|
182 Want to know more?
|
|
|
183 ==================
|
|
0
|
184
|
|
2
|
185 If you want to know more about **export2graphlan** please have a look at the tutorial
|
|
0
|
186 </help>
|
|
|
187 </tool>
|
