annotate metaphlan.xml @ 5:73f082e9fa2d

Set of improvements and fixes from Nicola Soranzo changeset: 9:c3dae016a3eb files: metaphlan.xml description: Update citation changeset: 8:f58b66b4e5fc files: metaphlan.xml description: Add select lists for -t and --tax_lev options Also some small fixes changeset: 7:94a2b29778b7 files: metaphlan_to_phyloxml.xml description: Clarify that only result of rel_ab analysis is accepted as input changeset: 6:b0eba028dee8 files: metaphlan.xml metaphlan_to_phyloxml.xml description: Fix whitespaces changeset: 5:4340075c8a93 files: tool_dependencies.xml description: Correct metaphlan clone URL to avoid a redirect changed metaphlan.xml changed metaphlan_to_phyloxml.xml changed tool_dependencies.xml
author nsegata
date Sun, 23 Dec 2012 18:46:23 +0100
parents 80b22b31633f
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
80b22b31633f Updated for MetaPhlAn v1.7 and tool_dependencies added for auto install
Jim Johnson <jj@umn.edu>
parents: 3
diff changeset
1 <tool id="metaphlan" name="MetaPhlAn" version="1.7.0">
80b22b31633f Updated for MetaPhlAn v1.7 and tool_dependencies added for auto install
Jim Johnson <jj@umn.edu>
parents: 3
diff changeset
2 <requirements>
80b22b31633f Updated for MetaPhlAn v1.7 and tool_dependencies added for auto install
Jim Johnson <jj@umn.edu>
parents: 3
diff changeset
3 <requirement type="package" version="1.7.0">metaphlan</requirement>
80b22b31633f Updated for MetaPhlAn v1.7 and tool_dependencies added for auto install
Jim Johnson <jj@umn.edu>
parents: 3
diff changeset
4 <requirement type="package">bowtie2</requirement>
80b22b31633f Updated for MetaPhlAn v1.7 and tool_dependencies added for auto install
Jim Johnson <jj@umn.edu>
parents: 3
diff changeset
5 </requirements>
0
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>
5
73f082e9fa2d Set of improvements and fixes from Nicola Soranzo
nsegata
parents: 4
diff changeset
8 python \${METAPHLAN_PATH}/metaphlan.py
73f082e9fa2d Set of improvements and fixes from Nicola Soranzo
nsegata
parents: 4
diff changeset
9 $input
73f082e9fa2d Set of improvements and fixes from Nicola Soranzo
nsegata
parents: 4
diff changeset
10 -t $analysis_type.analysis_type_select
73f082e9fa2d Set of improvements and fixes from Nicola Soranzo
nsegata
parents: 4
diff changeset
11 #if $analysis_type.analysis_type_select == "rel_ab"
73f082e9fa2d Set of improvements and fixes from Nicola Soranzo
nsegata
parents: 4
diff changeset
12 --tax_lev $analysis_type.taxonomic_level
73f082e9fa2d Set of improvements and fixes from Nicola Soranzo
nsegata
parents: 4
diff changeset
13 #end if
73f082e9fa2d Set of improvements and fixes from Nicola Soranzo
nsegata
parents: 4
diff changeset
14 --bowtie2db \${METAPHLAN_PATH}/bowtie2db/mpa
73f082e9fa2d Set of improvements and fixes from Nicola Soranzo
nsegata
parents: 4
diff changeset
15 --no_map
73f082e9fa2d Set of improvements and fixes from Nicola Soranzo
nsegata
parents: 4
diff changeset
16 --bt2_ps $PresetsForBowtie2
73f082e9fa2d Set of improvements and fixes from Nicola Soranzo
nsegata
parents: 4
diff changeset
17 -o $output
0
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
18 </command>
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
19 <inputs>
5
73f082e9fa2d Set of improvements and fixes from Nicola Soranzo
nsegata
parents: 4
diff changeset
20 <param name="input" type="data" format="fasta,fastq" label="Input metagenome (multi-fasta of metagenomic reads, loaded with the Get Data module, see below for an example)"></param>
73f082e9fa2d Set of improvements and fixes from Nicola Soranzo
nsegata
parents: 4
diff changeset
21 <conditional name="analysis_type">
73f082e9fa2d Set of improvements and fixes from Nicola Soranzo
nsegata
parents: 4
diff changeset
22 <param name="analysis_type_select" type="select" label="Type of analysis to perform">
73f082e9fa2d Set of improvements and fixes from Nicola Soranzo
nsegata
parents: 4
diff changeset
23 <option value="rel_ab" selected="true">profiling a metagenomes in terms of relative abundances</option>
73f082e9fa2d Set of improvements and fixes from Nicola Soranzo
nsegata
parents: 4
diff changeset
24 <option value="reads_map">mapping from reads to clades (only reads hitting a marker)</option>
73f082e9fa2d Set of improvements and fixes from Nicola Soranzo
nsegata
parents: 4
diff changeset
25 <option value="clade_profiles">normalized marker counts for clades with at least a non-null marker</option>
73f082e9fa2d Set of improvements and fixes from Nicola Soranzo
nsegata
parents: 4
diff changeset
26 </param>
73f082e9fa2d Set of improvements and fixes from Nicola Soranzo
nsegata
parents: 4
diff changeset
27 <when value="rel_ab">
73f082e9fa2d Set of improvements and fixes from Nicola Soranzo
nsegata
parents: 4
diff changeset
28 <param name="taxonomic_level" type="select" label="Taxonomic level">
73f082e9fa2d Set of improvements and fixes from Nicola Soranzo
nsegata
parents: 4
diff changeset
29 <option value="a" selected="true">all taxonomic levels</option>
73f082e9fa2d Set of improvements and fixes from Nicola Soranzo
nsegata
parents: 4
diff changeset
30 <option value="k">kingdoms (Bacteria and Archaea) only</option>
73f082e9fa2d Set of improvements and fixes from Nicola Soranzo
nsegata
parents: 4
diff changeset
31 <option value="p">phyla only</option>
73f082e9fa2d Set of improvements and fixes from Nicola Soranzo
nsegata
parents: 4
diff changeset
32 <option value="c">classes only</option>
73f082e9fa2d Set of improvements and fixes from Nicola Soranzo
nsegata
parents: 4
diff changeset
33 <option value="o">orders only</option>
73f082e9fa2d Set of improvements and fixes from Nicola Soranzo
nsegata
parents: 4
diff changeset
34 <option value="f">families only</option>
73f082e9fa2d Set of improvements and fixes from Nicola Soranzo
nsegata
parents: 4
diff changeset
35 <option value="g">genera only</option>
73f082e9fa2d Set of improvements and fixes from Nicola Soranzo
nsegata
parents: 4
diff changeset
36 <option value="s">species only</option>
73f082e9fa2d Set of improvements and fixes from Nicola Soranzo
nsegata
parents: 4
diff changeset
37 </param>
73f082e9fa2d Set of improvements and fixes from Nicola Soranzo
nsegata
parents: 4
diff changeset
38 </when>
73f082e9fa2d Set of improvements and fixes from Nicola Soranzo
nsegata
parents: 4
diff changeset
39 </conditional>
73f082e9fa2d Set of improvements and fixes from Nicola Soranzo
nsegata
parents: 4
diff changeset
40 <param name="PresetsForBowtie2" type="select" label="Sensitivity options for read-marker similarity (as described by BowTie2)" help="Sensitive Local is recommended for avoiding overly-sensitive hits when using non-preprocessed fastq files">
73f082e9fa2d Set of improvements and fixes from Nicola Soranzo
nsegata
parents: 4
diff changeset
41 <option value="very-sensitive-local" selected="true">Very Sensitive Local</option>
73f082e9fa2d Set of improvements and fixes from Nicola Soranzo
nsegata
parents: 4
diff changeset
42 <option value="sensitive-local">Sensitive Local</option>
73f082e9fa2d Set of improvements and fixes from Nicola Soranzo
nsegata
parents: 4
diff changeset
43 <option value="very-sensitive">Very Sensitive</option>
73f082e9fa2d Set of improvements and fixes from Nicola Soranzo
nsegata
parents: 4
diff changeset
44 <option value="sensitive">Sensitive</option>
73f082e9fa2d Set of improvements and fixes from Nicola Soranzo
nsegata
parents: 4
diff changeset
45 </param>
73f082e9fa2d Set of improvements and fixes from Nicola Soranzo
nsegata
parents: 4
diff changeset
46 </inputs>
73f082e9fa2d Set of improvements and fixes from Nicola Soranzo
nsegata
parents: 4
diff changeset
47 <stdio>
73f082e9fa2d Set of improvements and fixes from Nicola Soranzo
nsegata
parents: 4
diff changeset
48 <exit_code range="1:" level="fatal" description="MetaPhlAn error" />
73f082e9fa2d Set of improvements and fixes from Nicola Soranzo
nsegata
parents: 4
diff changeset
49 </stdio>
73f082e9fa2d Set of improvements and fixes from Nicola Soranzo
nsegata
parents: 4
diff changeset
50 <outputs>
73f082e9fa2d Set of improvements and fixes from Nicola Soranzo
nsegata
parents: 4
diff changeset
51 <data name="output" format="tabular" label="${tool.name} on ${on_string} (${analysis_type.analysis_type_select} analysis)"/>
73f082e9fa2d Set of improvements and fixes from Nicola Soranzo
nsegata
parents: 4
diff changeset
52 </outputs>
73f082e9fa2d Set of improvements and fixes from Nicola Soranzo
nsegata
parents: 4
diff changeset
53 <tests>
73f082e9fa2d Set of improvements and fixes from Nicola Soranzo
nsegata
parents: 4
diff changeset
54 </tests>
73f082e9fa2d Set of improvements and fixes from Nicola Soranzo
nsegata
parents: 4
diff changeset
55 <help>
3
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
56 .. class:: infomark
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
57
5
73f082e9fa2d Set of improvements and fixes from Nicola Soranzo
nsegata
parents: 4
diff changeset
58 **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 "Get Data" link here in the left panel.
3
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
59
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
60 .. class:: infomark
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
61
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
62 **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
63
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
64 .. class:: infomark
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
65
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
66 **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
67
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
68 ---------
0
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
69
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
70 **What it does**
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
71
3
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
72 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
73
5
73f082e9fa2d Set of improvements and fixes from Nicola Soranzo
nsegata
parents: 4
diff changeset
74 Although MetaPhlAn can use both BlastN and BowTie2 in the read-to-marker mapping step, this Galaxy module uses only BowTie2 for computational reasons.
3
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
75
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
76 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
77
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
78 ---------
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
79
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
80 **Inputs**
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
81
5
73f082e9fa2d Set of improvements and fixes from Nicola Soranzo
nsegata
parents: 4
diff changeset
82 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
83
3
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
84 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
85
3
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
86 **Outputs**
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
87
5
73f082e9fa2d Set of improvements and fixes from Nicola Soranzo
nsegata
parents: 4
diff changeset
88 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.
3
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
89
5
73f082e9fa2d Set of improvements and fixes from Nicola Soranzo
nsegata
parents: 4
diff changeset
90 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
91
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
92 -----
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
93
3
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
94 **Citation and contacts**
0
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
95
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
96 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
97
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
98 | `Nicola Segata`_, Levi Waldron, Annalisa Ballarini, Vagheesh Narasimhan, Olivier Jousson, `Curtis Huttenhower`_.
5
73f082e9fa2d Set of improvements and fixes from Nicola Soranzo
nsegata
parents: 4
diff changeset
99 | "`Metagenomic microbial community profiling using unique clade-specific marker genes`_"
73f082e9fa2d Set of improvements and fixes from Nicola Soranzo
nsegata
parents: 4
diff changeset
100 | Nature Methods 9(8), 811-814 (2012)
3
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
101
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
102 .. _Nicola Segata: nsegata@hsph.harvard.edu
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
103 .. _Curtis Huttenhower: chuttenh@hsph.harvard.edu
5
73f082e9fa2d Set of improvements and fixes from Nicola Soranzo
nsegata
parents: 4
diff changeset
104 .. _Metagenomic microbial community profiling using unique clade-specific marker genes: http://www.nature.com/nmeth/journal/v9/n8/full/nmeth.2066.html
3
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
105
5
73f082e9fa2d Set of improvements and fixes from Nicola Soranzo
nsegata
parents: 4
diff changeset
106 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
3
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
107
e88fa24fa837 updated to version 1.6.0
nsegata
parents: 2
diff changeset
108 .. _contact us: nsegata@hsph.harvard.edu
5
73f082e9fa2d Set of improvements and fixes from Nicola Soranzo
nsegata
parents: 4
diff changeset
109 </help>
0
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
110 </tool>