Mercurial > repos > george-weingart > metaphlan

comparison metaphlan.xml @ 0:921c5be02e81 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Metaphlan
author george-weingart
date Tue, 13 May 2014 21:54:35 -0400
parents
children 90de8f4531b9
comparison
equal deleted inserted replaced
-1:000000000000 0:921c5be02e81
1 <tool id="metaphlan" name="MetaPhlAn" version="1.7.0">
2 <requirements>
3 <requirement type="package" version="1.7.0">metaphlan</requirement>
4 <requirement type="package">bowtie2</requirement>
5 </requirements>
6 <description>metagenomic profiler</description>
7 <command>
8 python \${METAPHLAN_PATH}/metaphlan.py
9 $input
10 --bowtie2_exe bowtie2
11 --bowtie2db \${METAPHLAN_PATH}/bowtie2db/mpa
12 --no_map -o $output --bt2_ps $PresetsForBowtie2
13 </command>
14 <inputs>
15 <param format="fasta" name="input" type="data" label="Input metagenome (multi-fasta of metagenomic reads, loaded with the Get Data module, see below for an example)"></param>
16 <param name="PresetsForBowtie2" type="select" format="text">
17 <label>Sensitivity options for read-marker similarity (as described by BowTie2)</label>
18 <option value="very-sensitive-local">Very Sensitive Local</option>
19 <option value="sensitive-local">Sensitive Local</option>
20 <option value="very-sensitive">Very Sensitive</option>
21 <option value="sensitive">Sensitive</option>
22 </param>
23 </inputs>
24 <outputs>
25 <data format="tabular" name="output" />
26 </outputs>
27 <tests>
28 <test>
29 <param name="input" value="metaphlan_input" ftype="fasta" />
30 <param name="PresetsForBowtie2" value="sensitive" />
31 <output name="output" file="metaphlan_output" />
32 <assert_contents>
33 <has_text text="k__Bacteria" />
34 <has_text text="k__Bacteria|p__Actinobacteria" />
35 </assert_contents>
36 </test>
37 </tests>
38
39
40
41 <help>
42
43 .. class:: infomark
44
45 **Input example:** You can try out MetaPhlAn using the synthetic dataset (250,000 reads) available at: https://bitbucket.org/nsegata/metaphlan/wiki/LC1.fna. There is no need to download the file, you can just copy-and-paste the dataset address in the "Upload File" module inside the "Load Data" link here in the left panel.
46
47 .. class:: infomark
48
49 **Computational time:** Unless the server is overloaded, you should expect the tool to process ~10,000 reads per second. The synthetic metagenome linked above (250,000 reads) should take no more than 30 seconds to complete.
50
51 .. class:: infomark
52
53 **Tip:** If your input is in FASTQ you can convert it in FASTA using the corresponding Galaxy module included in the "Convert Format" tools.
54
55 ---------
56
57 **What it does**
58
59 MetaPhlAn (Metagenomic Phylogenetic Analysis) is a computational tool for profiling the composition of microbial communities from metagenomic shotgun sequencing data. MetaPhlAn relies on unique clade-specific marker genes identified from reference genomes, allowing orders of magnitude speedups and unambiguous taxonomic assignments.
60
61 Although MetaPhlAn can use both BlastN and BowTie2 in the read-to-marker mapping step, this Galaxy module uses only BowTie2 for computational reasons.
62
63 For additional information about MetaPhlAn and the MetaPhlAn command line package, please refer to http://huttenhower.sph.harvard.edu/metaphlan or to the paper reported below. Please notice that most of the additional parameters that can be tuned with the command line version are set here to the default values.
64
65 ---------
66
67 **Inputs**
68
69 The input file must be a multi-fasta file containing metagenomic reads loaded with the "Get Data" module in the left panel. Reads can be as short as ~40 nt although lengths higher than 70 nt are recommended.
70
71 A synthetic metagenome you can use as sample input is available at https://bitbucket.org/nsegata/metaphlan/wiki/LC1.fna.
72
73 **Outputs**
74
75 The output is a two column tab-separated plain file reporting the predicted microbial clades present in the metagenomic samples and the corresponding relative abundances.
76
77 All taxonomic levels from domain to species will be reported and higher taxonomic levelis contain the sum of the abundances of its taxonomic leaf nodes (usually species) and, possibly, some lower level "unclassified" clades.
78
79 -----
80
81 **Citation and contacts**
82
83 If you find MetaPhlAn useful in your research, please cite our paper:
84
85 | `Nicola Segata`_, Levi Waldron, Annalisa Ballarini, Vagheesh Narasimhan, Olivier Jousson, `Curtis Huttenhower`_.
86 | "`Metagenomic microbial community profiling using unique clade-specific marker genes`_"
87 | Nature Methods, doi:10.1038/nmeth.2066, 2012
88 |
89
90 If you have any questions or comments, feel free to `contact us`_. Additional information are available at http://huttenhower.sph.harvard.edu/metaphlan and in the FAQ at the same page. You can also join and use our user group at https://groups.google.com/d/forum/metaphlan-users
91
92 .. _contact us: nsegata@hsph.harvard.edu
93 .. _Nicola Segata: nsegata@hsph.harvard.edu
94 .. _Curtis Huttenhower: chuttenh@hsph.harvard.edu
95 .. _Metagenomic microbial community profiling using unique clade-specific marker genes: http://www.nature.com/nmeth/journal/vaop/ncurrent/full/nmeth.2066.html
96
97 -----
98
99 .. class:: infomark
100
101 **Installing MetaPhlAn in your Galaxy environment**
102
103 Your are wellcome to include this module in your local Galaxy installation. You can find the source file for the module and the instructions to integrate it in the "galaxy_module" folder at
104
105 https://bitbucket.org/nsegata/metaphlan/src
106
107
108
109 </help>
110 </tool>