annotate export2graphlan.xml @ 0:cac6247cb1d3 draft

graphlan_import
author george-weingart
date Tue, 26 Aug 2014 14:51:29 -0400
parents
children 2c0d791fc950
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
1 <tool id="export2graphlan" name="export2graphlan" version="1.0.0">
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
2 <description>Export to Graphlan</description>
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
3 <command interpreter="python">
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
4 export2graphlan.py
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
5 -i $inp_data
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
6 -o $out_data
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
7 -t $output_tree_file
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
8 -a $output_annot_file
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
9 --title $export_title
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
10 --annotations $export_annotations
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
11 --external_annotations $export_external_annotations
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
12 --skip_rows 1,2
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
13 </command>
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
14
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
15 <inputs>
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
16 <param name="export_title" type="text" format="text" label="Title" value="Title"/>
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
17 <param name="export_annotations" type="text" format="text" label="Annotations" value="2,3"/>
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
18 <param name="export_external_annotations" type="text" format="text" label="External Annotations" value="4,5,6"/>
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
19 <param format="tabular" name="inp_data" type="data" label="Input used to run Lefse - See samples below - Please use Galaxy Get-Data/Upload-File. Use File-Type = Tabular" help="This is the file that was used as input for Lefse"/>
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
20 <param format="lefse_res" name="out_data" type="data" label="Output of Lefse" help="This is the Lefse output file"/>
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
21 </inputs>
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
22 <outputs>
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
23 <data name="output_annot_file" format="circl" />
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
24 <data name="output_tree_file" format="circl" />
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
25 </outputs>
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
26
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
27 <help>
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
28 **export2graphlan** is an automatic conversion script from **LEfSe**, **MetaPhlAn2**, and **HUMAnN** input and/or output files, to **GraPhlAn**. Input file can be also given in BIOM 2.0 format.
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
29
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
30 The aim of this tool is to support biologists, helping them by automatically write the tree and the annotation file for **GraPhlAn**.
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
31
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
32 ----
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
33
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
34 .. contents::
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
35
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
36 ----
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
37
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
38 Overview
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
39 ========
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
40
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
41 A graphical representation of how **export2graphlan** can be used in the analysis pipeline:
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
42
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
43 .. image:: https://bitbucket.org/repo/oL6bEG/images/3364692296-graphlan_integration.png
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
44 :height: 500
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
45 :width: 600
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
46
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
47
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
48 ----
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
49
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
50 HMP aerobiosis
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
51 ==============
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
52
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
53 A taxonomic tree that shows three different classes of oxygen (low, medium, and high), highlighting biomarker clades for each class. Data are taken from the HMP project.
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
54
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
55 .. image:: https://bitbucket.org/repo/oL6bEG/images/2487320460-hmp_aerobiosis.png
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
56 :height: 500
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
57 :width: 600
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
58
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
59
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
60 Pipeline
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
61 --------
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
62
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
63
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
64 # download the data
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
65 $ wget http://huttenhower.sph.harvard.edu/webfm_send/129 -O hmp_aerobiosis_small.txt
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
66
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
67 # convert the file in LEfSe format, and run LEfSe
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
68 $ format_input.py hmp_aerobiosis_small.txt hmp_aerobiosis_small.in -c 1 -s 2 -u 3 -o 1000000
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
69 $ run_lefse.py hmp_aerobiosis_small.in hmp_aerobiosis_small.res
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
70
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
71 # convert it!
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
72 $ export2graphlan.py -i hmp_aerobiosis_small.txt -o hmp_aerobiosis_small.res -t tree.txt -a annot.txt --title "HMP aerobiosis" --annotations 2,3 --external_annotations 4,5,6 --fname_row 0 --skip_rows 1,2 --ftop 200
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
73
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
74 # attach annotation to the tree
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
75 $ graphlan_annotate.py --annot annot.txt tree.txt outtree.txt
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
76
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
77 # generate the beautiful image
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
78 $ graphlan.py --dpi 300 --size 7.0 outtree.txt outimg.png --external_legends
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
79
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
80 The input file is downloaded from The Huttenhower Lab and given to **LEfSe** for biomarkers discovery. The two file (the *LEfSe input* and the *LEfSe output* files) are then passed to **export2graphlan**. In this case the levels 2 (*phylum*) and 3 (*class*) are annotated on the circular tree, while levels 4 (*order*), 5 (*family*), and 6 (*genus*) are put on the external legend.
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
81
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
82
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
83
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
84 </help>
cac6247cb1d3 graphlan_import
george-weingart
parents:
diff changeset
85 </tool>