changeset 3:e88fa24fa837

updated to version 1.6.0
author nsegata
date Wed, 06 Jun 2012 10:41:23 -0400
parents 1f80b01e1490
children 80b22b31633f
files metaphlan.xml
diffstat 1 files changed, 59 insertions(+), 90 deletions(-) [+]
line wrap: on
line diff
--- a/metaphlan.xml	Wed Jun 06 10:26:24 2012 -0400
+++ b/metaphlan.xml	Wed Jun 06 10:41:23 2012 -0400
@@ -1,121 +1,90 @@
-<tool id="metaphlan" name="MetaPhlAn" version="1.0">
+<tool id="metaphlan" name="MetaPhlAn" version="1.6.0">
 <requirements>
 <requirement type="package">metaphlan</requirement>
-<requirement type="package" version="2.2.25+">blast</requirement>
+<requirement type="package">bowtie2</requirement>
 </requirements>
   <description>Metagenomic Phylogenetic Analysis</description>
   <command>
-      metaphlan.py
-      #if str($source.type) == "fasta":
-          ${source.fasta_input}
-      #else:
-          ${source.blast_input}
-      #end if
-      ${metaphlan_out}
-      --nproc 4
-      #if str($source.type) == "fasta":
-      --blastout metagenome.outfmt6.txt
-      --evalue ${source.evalue}
-      #end if
-      --lib_dir ${GALAXY_DATA_INDEX_DIR}/shared/metaphlan
-      --min_cu_len ${min_cu_len}
-      --min_nreads ${min_nreads}
+	  metaphlan.py 
+	  $input  
+	  --bowtie2db ${GALAXY_DATA_INDEX_DIR}/shared/metaphlan/bowtie2db/mpa  
+	  --no_map  
+	  -o $output  
+	  --bt2_ps $PresetsForBowtie2 
   </command>
 
   <inputs>
+	<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>
+	<param name="PresetsForBowtie2" type="select" format="text">
+		<label>Sensitivity options for read-marker similarity (as described by BowTie2)</label>
+			<option value="very-sensitive-local">Very Sensitive  Local</option>
+			<option value="sensitive-local">Sensitive  Local</option>
+			<option value="very-sensitive">Very Sensitive</option>
+			<option value="sensitive">Sensitive</option>
+	</param>			
+</inputs>
+<outputs>
+	<data format="tabular" name="output" />
+</outputs>
+ 
+<tests>
+</tests>
 
-    <conditional name="source">
-        <param name="type" type="select" label="Input Type">
-            <option value="fasta">multi-fasta file containing metagenomic reads</option>
-            <option value="blast">NCBI BLAST output file</option>
-        </param>
-      <when value="fasta">
-        <param format="fasta" name="fasta_input" type="data" label="from"/>
-        <param name="evalue" type="float" size="15" value="0.00001" label="evalue threshold for the blasting" />
-      </when>
-      <when value="blast">
-        <param format="tabular" name="blast_input" type="data" label="from"/>
-      </when>
-    </conditional>
+<help>
 
-    <param name="tax_lev" type="select" label="Taxonomic Level" help="The taxonomic level for the relative abundance output">
-        <option value="a">All taxonomic levels</option>
-        <option value="k">Kingdoms (Bacteria and Archaea) only</option>
-        <option value="p">Phyla only</option>
-        <option value="c">Classes only</option>
-        <option value="o">Orders only</option>
-        <option value="f">Families only</option>
-        <option value="g">Genera only</option>
-        <option value="s">Species only</option>
-    </param>
-    <param name="min_cu_len" type="integer" value="10000" help="min_cu_len" label="Minimum total nucleotide length for the unique markers for estimating the abundance without considering children clade abundances" />
-    <param name="min_nreads" type="integer" value="5" help="min_nreads" label="minimum total reads assigned to a clade for estimating the abundance without considering children clade abundances" />
-  </inputs>
-  <outputs>
-    <data format="tabular" name="metaphlan_out" label="MetaPhlAn on ${on_string}" />
-    <data format="tabular" name="blast_out" from_work_dir="metagenome.outfmt6.txt" label="MetaPhlAn BLAST on ${on_string}">
-        <filter>source['type'] == "fasta"</filter>
-    </data>
-  </outputs>
-  <tests>
-  </tests>
-  <help>
+.. class:: infomark
+
+**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.
+
+.. class:: infomark
+
+**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.
+
+.. class:: infomark
+
+**Tip:** If your input is in FASTQ you can convert it in FASTA using the corresponding Galaxy module included in the "Convert Format" tools.
+
+---------
 
 **What it does**
-MetaPhlAn 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.
 
-MetaPhlAn main features are:
+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.
 
-More than 100x computational speedup compared to Blast-based approaches or other available methods with species level resolution
-Higher accuracy in estimating the true composition of microbial communities in terms of organismal relative abundance
-Unambiguous read-to-taxa assignments as conserved inter-clade sequences are removed from the reference sequence data
+Although MetaPhlAn can use both BlastN and BowTie2 in the read-to-marker mapping step, this Galaxy module uses only BowTie2 for computational reasons. 
+
+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.
 
 ---------
 
 **Inputs**
 
-The input file can be a multi-fasta file containing metagenomic reads OR a NCBI BLAST output file (-outfmt 6 format) of the metagenomic read fasta file against the metaflan database.
+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. 
 
-**outputs**
+A synthetic metagenome you can use as sample input is available at http://huttenhower.sph.harvard.edu/sites/default/files/LC1.fna
 
-The output is a tab-separated output file of the predicted taxon relative abundances.
-If the input is a multi-fasta file then the output from the BLAST operation is also provided as an additional output.
+**Outputs**
 
----------
+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. 
 
-**Settings**::
-
-  --tax_lev TAXONOMIC_LEVEL
-                        The taxonomic level for the relative abundance 
-                        output:
-                        'a' : all taxonomic levels
-                        'k' : kingdoms (Bacteria and Archaea) only
-                        'p' : phyla only
-                        'c' : classes only
-                        'o' : orders only
-                        'f' : families only
-                        'g' : genera only
-                        's' : species only
-                        [default 'a']
-  --evalue              evalue threshold for the blasting
-                        [default 1e-6]
-  --min_cu_len          minimum total nucleotide lenght for the unique
-                        markers for estimating the abundance without
-                        considering children clade abundances
-                        [default 10000]
-  --min_nreads          minimum total reads assigned to a clade for
-                        estimating the abundance without considering
-                        children clade abundances
-                        [default 5]
+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. 
 
 -----
 
-**Citation**
+**Citation and contacts**
 
 If you find MetaPhlAn useful in your research, please cite our paper:
-Nicola Segata, Levi Waldron, Annalisa Ballarini, Vagheesh Narasimhan, Olivier Jousson, Curtis Huttenhower.
-"Fast and accurate metagenomic profiling of microbial community composition using unique clade-specific marker genes"
-***in review***
+
+| `Nicola Segata`_, Levi Waldron, Annalisa Ballarini, Vagheesh Narasimhan, Olivier Jousson, `Curtis Huttenhower`_.
+| **"Fast and accurate metagenomic profiling of microbial community composition using unique clade-specific marker genes"**
+| Nature Methods, 2012 (in press)
+
+.. _Nicola Segata: nsegata@hsph.harvard.edu
+.. _Curtis Huttenhower: chuttenh@hsph.harvard.edu
+
+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
+
+.. _contact us: nsegata@hsph.harvard.edu
+
 
     </help>
 </tool>