annotate metaphlan.xml @ 4:3468e70d3ed0 draft

Indents
author Jim Johnson <jj@umn.edu>
date Wed, 10 Oct 2012 08:49:28 -0500
parents 51288d868a5c
children 61f300dbc6ac
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
868624c77941 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
1 <tool id="metaphlan" name="MetaPhlAn" version="1.7.0">
4
3468e70d3ed0 Indents
Jim Johnson <jj@umn.edu>
parents: 3
diff changeset
2 <requirements>
1
868624c77941 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
3 <requirement type="package" version="1.7.0">metaphlan</requirement>
868624c77941 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
4 <requirement type="package">bowtie2</requirement>
4
3468e70d3ed0 Indents
Jim Johnson <jj@umn.edu>
parents: 3
diff changeset
5 </requirements>
0
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
6 <description>Metagenomic Phylogenetic Analysis</description>
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
7 <command>
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
8 metaphlan.py
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
9 $input
3
51288d868a5c tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents: 1
diff changeset
10 --bowtie2db \${METAPHLAN_PATH}/bowtie2db/mpa
0
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
11 --no_map
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
12 -o $output
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
13 --bt2_ps $PresetsForBowtie2
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
14 </command>
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
15
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
16 <inputs>
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
17 <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>
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
18 <param name="PresetsForBowtie2" type="select" format="text">
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
19 <label>Sensitivity options for read-marker similarity (as described by BowTie2)</label>
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
20 <option value="very-sensitive-local">Very Sensitive Local</option>
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
21 <option value="sensitive-local">Sensitive Local</option>
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
22 <option value="very-sensitive">Very Sensitive</option>
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
23 <option value="sensitive">Sensitive</option>
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
24 </param>
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
25 </inputs>
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
26 <outputs>
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
27 <data format="tabular" name="output" />
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
28 </outputs>
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
29
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
30 <tests>
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
31 </tests>
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
32
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
33 <help>
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
34
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
35 .. class:: infomark
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
36
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
37 **Input example:** You can try out MetaPhlAn using the synthetic dataset (250,000 reads) available at: http://huttenhower.sph.harvard.edu/sites/default/files/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.
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
38
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
39 .. class:: infomark
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
40
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
41 **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.
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
42
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
43 .. class:: infomark
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
44
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
45 **Tip:** If your input is in FASTQ you can convert it in FASTA using the corresponding Galaxy module included in the "Convert Format" tools.
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
46
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
47 ---------
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
48
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
49 **What it does**
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
50
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
51 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.
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
52
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
53 Although MetaPhlAn can use both BlastN and BowTie2 in the read-to-marker mapping step, this Galaxy module uses only BowTie2 for computational reasons.
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
54
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
55 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.
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
56
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
57 ---------
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
58
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
59 **Inputs**
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
60
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
61 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.
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
62
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
63 A synthetic metagenome you can use as sample input is available at http://huttenhower.sph.harvard.edu/sites/default/files/LC1.fna
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
64
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
65 **Outputs**
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
66
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
67 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.
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
68
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
69 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.
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
70
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
71 -----
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
72
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
73 **Citation and contacts**
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
74
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
75 If you find MetaPhlAn useful in your research, please cite our paper:
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
76
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
77 | `Nicola Segata`_, Levi Waldron, Annalisa Ballarini, Vagheesh Narasimhan, Olivier Jousson, `Curtis Huttenhower`_.
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
78 | **"Fast and accurate metagenomic profiling of microbial community composition using unique clade-specific marker genes"**
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
79 | Nature Methods, 2012 (in press)
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
80
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
81 .. _Nicola Segata: nsegata@hsph.harvard.edu
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
82 .. _Curtis Huttenhower: chuttenh@hsph.harvard.edu
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
83
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
84 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
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
85
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
86 .. _contact us: nsegata@hsph.harvard.edu
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
87
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
88
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
89 </help>
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
90 </tool>
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
91