annotate metaphlan.xml @ 1:868624c77941 draft

Add tool_dependencies.xml
author Jim Johnson <jj@umn.edu>
date Tue, 09 Oct 2012 15:53:06 -0500
parents 0ec6c5781381
children 51288d868a5c
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">
0
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
2 <requirements>
1
868624c77941 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
3 <requirement type="set_environment">METAPHLAN_BASE</requirement>
868624c77941 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
4 <requirement type="package" version="1.7.0">metaphlan</requirement>
868624c77941 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
5 <requirement type="package">bowtie2</requirement>
0
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
6 </requirements>
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
7 <description>Metagenomic Phylogenetic Analysis</description>
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
8 <command>
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
9 metaphlan.py
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
10 $input
1
868624c77941 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
11 --bowtie2db ${METAPHLAN_BASE}/bowtie2db/mpa
0
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
12 --no_map
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
13 -o $output
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
14 --bt2_ps $PresetsForBowtie2
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
15 </command>
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
16
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
17 <inputs>
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
18 <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
19 <param name="PresetsForBowtie2" type="select" format="text">
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
20 <label>Sensitivity options for read-marker similarity (as described by BowTie2)</label>
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
21 <option value="very-sensitive-local">Very Sensitive Local</option>
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
22 <option value="sensitive-local">Sensitive Local</option>
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
23 <option value="very-sensitive">Very Sensitive</option>
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
24 <option value="sensitive">Sensitive</option>
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
25 </param>
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
26 </inputs>
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
27 <outputs>
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
28 <data format="tabular" name="output" />
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
29 </outputs>
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
30
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
31 <tests>
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
32 </tests>
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
33
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
34 <help>
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
35
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
36 .. class:: infomark
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
37
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
38 **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
39
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
40 .. class:: infomark
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
41
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
42 **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
43
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
44 .. class:: infomark
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
45
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
46 **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
47
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
48 ---------
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
49
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
50 **What it does**
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
51
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
52 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
53
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
54 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
55
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
56 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
57
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
58 ---------
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
59
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
60 **Inputs**
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
61
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
62 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
63
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
64 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
65
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
66 **Outputs**
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
67
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
68 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
69
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
70 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
71
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
72 -----
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
73
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
74 **Citation and contacts**
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
75
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
76 If you find MetaPhlAn useful in your research, please cite our paper:
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
77
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
78 | `Nicola Segata`_, Levi Waldron, Annalisa Ballarini, Vagheesh Narasimhan, Olivier Jousson, `Curtis Huttenhower`_.
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
79 | **"Fast and accurate metagenomic profiling of microbial community composition using unique clade-specific marker genes"**
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
80 | Nature Methods, 2012 (in press)
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
81
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
82 .. _Nicola Segata: nsegata@hsph.harvard.edu
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
83 .. _Curtis Huttenhower: chuttenh@hsph.harvard.edu
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
84
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
85 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
86
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
87 .. _contact us: nsegata@hsph.harvard.edu
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
88
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
89
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
90 </help>
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
91 </tool>
0ec6c5781381 Uploaded
jjohnson
parents:
diff changeset
92