annotate metaphlan.xml @ 0:4f3fe44edb3f

Initial upload. Still needs tests.
author dannon
date Thu, 29 Mar 2012 03:32:11 -0400
parents
children 1f80b01e1490
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
1 <tool id="metaphlan" name="MetaPhlAn" version="1.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>
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
4 <requirement type="package" version="2.2.25+">blast</requirement>
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>
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
8 metaphlan.py
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
9 #if str($source.type) == "fasta":
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
10 ${source.fasta_input}
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
11 #else:
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
12 ${source.blast_input}
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
13 #end if
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
14 ${metaphlan_out}
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
15 --nproc 4
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
16 #if str($source.type) == "fasta":
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
17 --blastout metagenome.outfmt6.txt
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
18 --evalue ${source.evalue}
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
19 #end if
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
20 --lib_dir ${GALAXY_DATA_INDEX_DIR}/shared/metaphlan
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
21 --min_cu_len ${min_cu_len}
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
22 --min_nreads ${min_nreads}
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
23 </command>
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
24 <inputs>
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
25
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
26 <conditional name="source">
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
27 <param name="type" type="select" label="Input Type">
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
28 <option value="fasta">multi-fasta file containing metagenomic reads</option>
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
29 <option value="blast">NCBI BLAST output file</option>
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
30 </param>
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
31 <when value="fasta">
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
32 <param format="fasta" name="fasta_input" type="data" label="from"/>
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
33 <param name="evalue" type="float" size="15" value="0.00001" label="evalue threshold for the blasting" />
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
34 </when>
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
35 <when value="blast">
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
36 <param format="tabular" name="blast_input" type="data" label="from"/>
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
37 </when>
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
38 </conditional>
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
39
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
40 <param name="tax_lev" type="select" label="Taxonomic Level" help="The taxonomic level for the relative abundance output">
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
41 <option value="a">All taxonomic levels</option>
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
42 <option value="k">Kingdoms (Bacteria and Archaea) only</option>
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
43 <option value="p">Phyla only</option>
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
44 <option value="c">Classes only</option>
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
45 <option value="o">Orders only</option>
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
46 <option value="f">Families only</option>
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
47 <option value="g">Genera only</option>
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
48 <option value="s">Species only</option>
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
49 </param>
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
50 <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" />
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
51 <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" />
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
52 </inputs>
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
53 <outputs>
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
54 <data format="tabular" name="metaphlan_out" label="MetaPhlAn on ${on_string}" />
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
55 <data format="tabular" name="blast_out" from_work_dir="metagenome.outfmt6.txt" label="MetaPhlAn BLAST on ${on_string}">
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
56 <filter>source['type'] == "fasta"</filter>
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
57 </data>
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
58 </outputs>
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
59 <tests>
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
60 </tests>
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
61 <help>
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
62
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
63 **What it does**
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
64 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.
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
65
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
66 MetaPhlAn main features are:
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
67
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
68 More than 100x computational speedup compared to Blast-based approaches or other available methods with species level resolution
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
69 Higher accuracy in estimating the true composition of microbial communities in terms of organismal relative abundance
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
70 Unambiguous read-to-taxa assignments as conserved inter-clade sequences are removed from the reference sequence data
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
71
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
72 ---------
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
73
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
74 **Inputs**
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
75
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
76 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.
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
77
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
78 **outputs**
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
79
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
80 The output is a tab-separated output file of the predicted taxon relative abundances.
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
81 If the input is a multi-fasta file then the output from the BLAST operation is also provided as an additional output.
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
82
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
83 ---------
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
84
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
85 **Settings**::
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
86
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
87 --tax_lev TAXONOMIC_LEVEL
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
88 The taxonomic level for the relative abundance
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
89 output:
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
90 'a' : all taxonomic levels
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
91 'k' : kingdoms (Bacteria and Archaea) only
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
92 'p' : phyla only
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
93 'c' : classes only
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
94 'o' : orders only
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
95 'f' : families only
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
96 'g' : genera only
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
97 's' : species only
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
98 [default 'a']
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
99 --evalue evalue threshold for the blasting
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
100 [default 1e-6]
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
101 --min_cu_len minimum total nucleotide lenght for the unique
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
102 markers for estimating the abundance without
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
103 considering children clade abundances
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
104 [default 10000]
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
105 --min_nreads minimum total reads assigned to a clade for
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
106 estimating the abundance without considering
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
107 children clade abundances
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
108 [default 5]
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
109
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
110 -----
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
111
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
112 **Citation**
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
113
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
114 If you find MetaPhlAn useful in your research, please cite our paper:
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
115 Nicola Segata, Levi Waldron, Annalisa Ballarini, Vagheesh Narasimhan, Olivier Jousson, Curtis Huttenhower.
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
116 "Fast and accurate metagenomic profiling of microbial community composition using unique clade-specific marker genes"
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
117 ***in review***
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
118
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
119 </help>
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
120 </tool>
4f3fe44edb3f Initial upload. Still needs tests.
dannon
parents:
diff changeset
121