annotate metaphlan.xml @ 3:e88fa24fa837

updated to version 1.6.0
author nsegata
date Wed, 06 Jun 2012 10:41:23 -0400
parents 1f80b01e1490
children 80b22b31633f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
1 <tool id="metaphlan" name="MetaPhlAn" version="1.6.0">
0
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
2 <requirements>
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
3 <requirement type="package">metaphlan</requirement>
3
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
4 <requirement type="package">bowtie2</requirement>
0
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
5 </requirements>
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
6 <description>Metagenomic Phylogenetic Analysis</description>
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
7 <command>
3
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
8 metaphlan.py
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
9 $input
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
10 --bowtie2db ${GALAXY_DATA_INDEX_DIR}/shared/metaphlan/bowtie2db/mpa
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
11 --no_map
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
12 -o $output
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
13 --bt2_ps $PresetsForBowtie2
0
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
14 </command>
2
1f80b01e1490 changed metaphlan.xml
nsegata
parents: 0
diff changeset
15
0
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
16 <inputs>
3
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
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>
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
18 <param name="PresetsForBowtie2" type="select" format="text">
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
19 <label>Sensitivity options for read-marker similarity (as described by BowTie2)</label>
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
20 <option value="very-sensitive-local">Very Sensitive Local</option>
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
21 <option value="sensitive-local">Sensitive Local</option>
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
22 <option value="very-sensitive">Very Sensitive</option>
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
23 <option value="sensitive">Sensitive</option>
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
24 </param>
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
25 </inputs>
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
26 <outputs>
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
27 <data format="tabular" name="output" />
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
28 </outputs>
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
29
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
30 <tests>
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
31 </tests>
0
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
32
3
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
33 <help>
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
34
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
35 .. class:: infomark
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
36
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
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.
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
38
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
39 .. class:: infomark
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
40
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
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.
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
42
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
43 .. class:: infomark
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
44
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
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.
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
46
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
47 ---------
0
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
48
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
49 **What it does**
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
50
3
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
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.
0
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
52
3
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
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.
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
54
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
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.
0
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
56
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
57 ---------
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
58
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
59 **Inputs**
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
60
3
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
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.
0
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
62
3
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
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
0
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
64
3
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
65 **Outputs**
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
66
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
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.
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
68
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
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.
0
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
70
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
71 -----
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
72
3
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
73 **Citation and contacts**
0
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
74
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
75 If you find MetaPhlAn useful in your research, please cite our paper:
3
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
76
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
77 | `Nicola Segata`_, Levi Waldron, Annalisa Ballarini, Vagheesh Narasimhan, Olivier Jousson, `Curtis Huttenhower`_.
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
78 | **"Fast and accurate metagenomic profiling of microbial community composition using unique clade-specific marker genes"**
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
79 | Nature Methods, 2012 (in press)
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
80
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
81 .. _Nicola Segata: nsegata@hsph.harvard.edu
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
82 .. _Curtis Huttenhower: chuttenh@hsph.harvard.edu
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
83
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
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
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
85
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
86 .. _contact us: nsegata@hsph.harvard.edu
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
87
0
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
88
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
89 </help>
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
90 </tool>
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
91