Mercurial > repos > george-weingart > graphlan_import
annotate import2graphlan.xml @ 43:c5c1037078e5 draft
Uploaded
| author | george-weingart | 
|---|---|
| date | Sat, 06 Sep 2014 13:51:49 -0400 | 
| parents | fa2bd894219f | 
| children | d3e731ed55b1 | 
| rev | line source | 
|---|---|
| 
23
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
1 <tool id="import2graphlan" name="import2graphlan" version="1.0.0"> | 
| 25 | 2 <description>Import to Graphlan</description> | 
| 
23
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
3 <command interpreter="python"> | 
| 
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
4 export2graphlan.py | 
| 
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
5 -i $inp_data | 
| 
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
6 -o $out_data | 
| 
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
7 -t $output_tree_file | 
| 
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
8 -a $output_annot_file | 
| 
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
9 | 
| 
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
10 --annotations $export_annotations | 
| 
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
11 --external_annotations $export_external_annotations | 
| 37 | 12 --background_levels $background_levels | 
| 38 | 13 | 
| 14 | |
| 15 #if $str($gchoice.global_choice) == "a": | |
| 16 | |
| 17 #if $str($gchoice.background_clades) != " ": | |
| 18 --background_clades $gchoice.background_clades | |
| 19 #end if | |
| 20 #if $str($gchoice.background_colors) != " ": | |
| 21 --background_colors $gchoice.background_colors | |
| 22 #end if | |
| 23 | |
| 24 #if $str($gchoice.export_title) != " ": | |
| 25 --title $gchoice.export_title | |
| 26 #end if | |
| 27 | |
| 28 | |
| 39 | 29 | 
| 30 | |
| 38 | 31 --title_font_size $gchoice.title_font_size | 
| 32 --def_clade_size $gchoice.def_clade_size | |
| 33 --min_clade_size $gchoice.min_clade_size | |
| 34 --max_clade_size $gchoice.max_clade_size | |
| 35 --def_font_size $gchoice.def_font_size | |
| 36 --min_font_size $gchoice.min_font_size | |
| 37 --max_font_size $gchoice.max_font_size | |
| 38 --annotation_legend_font_size $gchoice.annotation_legend_font_size | |
| 39 --abundance_threshold $gchoice.abundance_threshold | |
| 39 | 40 --least_biomarkers $gchoice.least_biomarkers | 
| 41 | |
| 42 #if $str($gchoice.discard_otus ) == "1": | |
| 43 --discard_otus | |
| 44 #end if | |
| 
23
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
45 #end if | 
| 38 | 46 | 
| 47 | |
| 
23
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
48 | 
| 
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
49 --skip_rows 1,2 | 
| 
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
50 </command> | 
| 
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
51 | 
| 29 | 52 <inputs> | 
| 
23
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
53 <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"/> | 
| 
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
54 <param format="lefse_internal_res" name="out_data" type="data" label="Output of Lefse" help="This is the Lefse output file"/> | 
| 29 | 55 <param name="export_annotations" type="text" format="text" label="Annotations" value="2,3"/> | 
| 56 <param name="export_external_annotations" type="text" format="text" label="External Annotations" value="4,5,6"/> | |
| 37 | 57 <param name="background_levels" type="text" format="text" label="Background Levels" value="1,2,3"/> | 
| 30 | 58 | 
| 59 <conditional name="gchoice"> | |
| 60 <param name="global_choice" type="select" label="Select Global Choices" help="Select choices"> | |
| 61 <option value="d" selected='True'>Default</option> | |
| 62 <option value="a">Advanced</option> | |
| 63 </param> | |
| 38 | 64 | 
| 30 | 65 <when value="a"> | 
| 66 <param name="background_clades" type="text" format="text" label="Background Clades" value=" " /> | |
| 67 <param name="background_colors" type="text" format="text" label="Background Colors" value=" " /> | |
| 68 <param name="export_title" type="text" format="text" label="Title" value=" "/> | |
| 69 <param name="title_font_size" type="integer" size="4" value="15" label="Title font size"/> | |
| 70 <param name="def_clade_size" type="integer" size="4" value="0" label="Default Clade size"/> | |
| 71 <param name="min_clade_size" type="integer" size="4" value="20" label="Minimum Clade size that are Biomarkers"/> | |
| 72 <param name="max_clade_size" type="integer" size="4" value="200" label="Maximum Clade size that are Biomarkers"/> | |
| 73 <param name="def_font_size" type="integer" size="4" value="10" label="Default font size"/> | |
| 74 <param name="min_font_size" type="integer" size="4" value="8" label="Minimum font size "/> | |
| 75 <param name="max_font_size" type="integer" size="4" value="12" label="Maximum font size "/> | |
| 76 <param name="annotation_legend_font_size" type="integer" size="4" value="10" label="Annotation legend font size "/> | |
| 77 <param name="abundance_threshold" type="float" value="20.0" label="Abundance threshold: minimun abundace value for a clade to be annotated"/> | |
| 78 <param name="most_abundant" type="integer" size="4" value="0" label=" When only lefse_input is provided, you can specify how many clades to highlight "/> | |
| 79 <param name="least_biomarkers" type="integer" size="4" value="0" label="Minimum number of biomarkers to extract "/> | |
| 39 | 80 <param name="discard_otus" type="select" label="If specified the OTU ids will be discarded from the taxonomy" value="0" > | 
| 41 | 81 <option value="0">No</option> | 
| 82 <option value="1">Yes</option> | |
| 39 | 83 </param> | 
| 84 | |
| 85 | |
| 86 | |
| 30 | 87 </when> | 
| 88 </conditional> | |
| 
23
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
89 </inputs> | 
| 29 | 90 <outputs> | 
| 
23
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
91 <data name="output_annot_file" format="circl" /> | 
| 
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
92 <data name="output_tree_file" format="circl" /> | 
| 29 | 93 </outputs> | 
| 
23
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
94 | 
| 
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
95 <help> | 
| 
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
96 Overview | 
| 
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
97 ======== | 
| 
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
98 **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. | 
| 
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
99 | 
| 
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
100 The aim of this tool is to support biologists, helping them by provide the tree and the annotation file for GraPhlAn, automatically. | 
| 
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
101 | 
| 
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
102 Input files | 
| 39 | 103 =========== | 
| 
23
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
104 | 
| 
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
105 As shown in the image below, export2graphlan can work with just one of the following files or with both of them. | 
| 
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
106 | 
| 
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
107 * **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. | 
| 
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
108 | 
| 
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
109 * **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. | 
| 
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
110 | 
| 
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
111 Input parameters | 
| 41 | 112 ================ | 
| 
23
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
113 | 
| 42 | 114 **--annotations** ANNOTATIONS List which levels should be annotated in the tree. Use a comma separate values form, e.g., -annotation_levels 1,2,3. Default is None | 
| 41 | 115 | 
| 42 | 116 **--external_annotations** EXTERNAL_ANNOTATIONS | 
| 117 List which levels should use the external legend for the annotation. Use a comma separate values form, | |
| 
23
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
118 e.g., --annotation_levels 1,2,3. Default is None | 
| 42 | 119 | 
| 43 | 120 **--background_levels** BACKGROUND_LEVELS | 
| 
23
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
121 List which levels should be highlight with a shaded | 
| 
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
122 background. Use a comma separate values form, e.g., | 
| 
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
123 --background_levels 1,2,3 | 
| 42 | 124 | 
| 43 | 125 **--background_clades** BACKGROUND_CLADES | 
| 42 | 126 Specify the clades that should be highlight with a shaded background. Use a comma separate values form and surround the string with " if it contains spaces. | 
| 
23
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
127 Example: --background_clades "Bacteria.Actinobacteria, | 
| 
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
128 Bacteria.Bacteroidetes.Bacteroidia, | 
| 
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
129 Bacteria.Firmicutes.Clostridia.Clostridiales" | 
| 42 | 130 | 
| 43 | 131 **--background_colors** BACKGROUND_COLORS | 
| 42 | 132 Set the color to use for the shaded background. Colors can be either in RGB or HSV (using a semi-colon to separate values, surrounded with ()) format. | 
| 133 | |
| 134 Use a comma separate values form and surround the string with " if it contains spaces. | |
| 135 | |
| 136 Example: | |
| 43 | 137 -------- | 
| 138 --background_colors "#29cc36, (150; 100; 100), (280;80; 88)" | |
| 42 | 139 | 
| 43 | 140 **--title TITLE** If specified set the title of the GraPhlAn plot. | 
| 42 | 141 Surround the string with " if it contains spaces, e.g., --title "Title example" | 
| 142 | |
| 43 | 143 **--title_font_size** TITLE_FONT_SIZE | 
| 
23
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
144 Set the title font size. Default is 15 | 
| 43 | 145 | 
| 146 **--def_clade_size** DEF_CLADE_SIZE | |
| 147 Set a default size for clades that are not found as biomarkers by LEfSe. Default is 10 | |
| 148 | |
| 149 **--min_clade_size** MIN_CLADE_SIZE | |
| 
23
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
150 Set the minimum value of clades that are biomarkers. | 
| 
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
151 Default is 20 | 
| 43 | 152 | 
| 153 **--max_clade_size** MAX_CLADE_SIZE | |
| 
23
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
154 Set the maximum value of clades that are biomarkers. | 
| 
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
155 Default is 200 | 
| 43 | 156 | 
| 157 **--def_font_size** DEF_FONT_SIZE | |
| 
23
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
158 Set a default font size. Default is 10 | 
| 43 | 159 | 
| 160 **--min_font_size** MIN_FONT_SIZE | |
| 
23
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
161 Set the minimum font size to use. Default is 8 | 
| 43 | 162 | 
| 163 **--max_font_size** MAX_FONT_SIZE | |
| 
23
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
164 Set the maximum font size. Default is 12 | 
| 43 | 165 | 
| 166 **--annotation_legend**_font_size ANNOTATION_LEGEND_FONT_SIZE | |
| 167 Set the font size for the annotation legend. Default is 10 | |
| 168 | |
| 169 **--abundance_threshold** ABUNDANCE_THRESHOLD | |
| 170 Set the minimun abundace value for a clade to be annotated. Default is 20.0 | |
| 171 | |
| 172 **--most_abundant** MOST_ABUNDANT | |
| 173 When only lefse_input is provided, you can specify how many clades highlight. | |
| 174 Since the biomarkers are missing, they will be chosen from the most abundant | |
| 175 | |
| 176 **--least_biomarkers** LEAST_BIOMARKERS | |
| 177 When only lefse_input is provided, you can specify the minimum number of biomarkers to extract. | |
| 178 The taxonomy is parsed, and the level is choosen in order to have at least the specified number of biomarkers | |
| 179 | |
| 180 **--discard_otus** If specified the OTU ids will be discarded from the taxonmy. | |
| 181 Default behavior keep OTU ids in taxonomy | |
| 182 | |
| 183 **--internal_levels** If specified sum-up from leaf to root the abundances values. Default behavior do not sum-up abundances on the internal nodes | |
| 25 | 184 | 
| 
23
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
185 | 
| 41 | 186 Input data matrix parameters | 
| 187 ============================ | |
| 39 | 188 | 
| 
23
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
189 --sep SEP | 
| 41 | 190 | 
| 
23
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
191 --out_table OUT_TABLE : This is where to write the processed data matrix to file | 
| 
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
192 | 
| 
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
193 --fname_row FNAME_ROW : Row number containing the names of the features (default 0, specify -1 if no names are present in the matrix) | 
| 
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
194 | 
| 41 | 195 --sname_row SNAME_ROW column number containing the names of the samples (default 0, specify -1 if no names are present in the matrix) | 
| 196 | |
| 197 --metadata_rows METADATA_ROWS Row numbers to use as metadata[default None, meaning no metadata | |
| 198 | |
| 199 --skip_rows SKIP_ROWS Row numbers to skip (0-indexed, comma separated) from the input file[default None, meaning no rows skipped | |
| 200 | |
| 201 --sperc SPERC Percentile of sample value distribution for sample selection | |
| 202 | |
| 203 --fperc FPERC Percentile of feature value distribution for sample selection | |
| 204 | |
| 205 --stop STOP Number of top samples to select (ordering based on percentile specified by --sperc) | |
| 206 | |
| 207 --ftop FTOP Number of top features to select (ordering based on percentile specified by --fperc) | |
| 208 | |
| 209 --def_na DEF_NA Set the default value for missing values [default None which means no replacement] | |
| 
23
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
210 | 
| 
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
211 Integration | 
| 
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
212 =========== | 
| 
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
213 | 
| 
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
214 A graphical representation of how **export2graphlan** can be integrated in the analysis pipeline: | 
| 
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
215 | 
| 
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
216 .. image:: https://bitbucket.org/repo/oL6bEG/images/3364692296-graphlan_integration.png | 
| 
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
217 :height: 672 | 
| 
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
218 :width: 800 | 
| 
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
219 | 
| 
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
220 Want to know more? | 
| 
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
221 ================== | 
| 
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
222 | 
| 27 | 223 If you want to know more about **export2graphlan** please have a look at the tutorial `here`_ | 
| 26 | 224 | 
| 225 | |
| 27 | 226 .. _here: https://bitbucket.org/nsegata/graphlan/wiki/export2graphlan%20-%20tutorial | 
| 
23
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
227 </help> | 
| 
 
01ba9f83f9a7
Renamed the function to import rather than export
 
george-weingart 
parents:  
diff
changeset
 | 
228 </tool> | 
