annotate qiime/alpha_diversity.xml @ 0:003162f90751 draft

Uploaded
author azuzolo
date Wed, 06 Jun 2012 16:40:30 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
003162f90751 Uploaded
azuzolo
parents:
diff changeset
1 <tool id="alpha_diversity" name="alpha_diversity" version="1.2.0">
003162f90751 Uploaded
azuzolo
parents:
diff changeset
2 <description>Calculate alpha diversity on each sample in an otu table, using a variety of alpha diversity metrics</description>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
3 <requirements>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
4 <requirement type="binary">alpha_diversity.py</requirement>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
5 </requirements>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
6 <command interpreter="python">
003162f90751 Uploaded
azuzolo
parents:
diff changeset
7 qiime_wrapper.py
003162f90751 Uploaded
azuzolo
parents:
diff changeset
8 #if $run_type.input_type.__str__ == "multi":
003162f90751 Uploaded
azuzolo
parents:
diff changeset
9 --galaxy_logfile=$output_path
003162f90751 Uploaded
azuzolo
parents:
diff changeset
10 --galaxy_outputdir=$output_path.extra_files_path
003162f90751 Uploaded
azuzolo
parents:
diff changeset
11 #end if
003162f90751 Uploaded
azuzolo
parents:
diff changeset
12 alpha_diversity.py
003162f90751 Uploaded
azuzolo
parents:
diff changeset
13 #if $run_type.input_type.__str__ == "multi":
003162f90751 Uploaded
azuzolo
parents:
diff changeset
14 --input_path=$input_path.extra_files_path
003162f90751 Uploaded
azuzolo
parents:
diff changeset
15 --output_path=$output_path.extra_files_path
003162f90751 Uploaded
azuzolo
parents:
diff changeset
16 #else:
003162f90751 Uploaded
azuzolo
parents:
diff changeset
17 --output_path=$output_path
003162f90751 Uploaded
azuzolo
parents:
diff changeset
18 --input_path=$input_path
003162f90751 Uploaded
azuzolo
parents:
diff changeset
19 #end if
003162f90751 Uploaded
azuzolo
parents:
diff changeset
20 --metrics=$metrics
003162f90751 Uploaded
azuzolo
parents:
diff changeset
21 #if $metrics.__str__ == 'PD_whole_tree':
003162f90751 Uploaded
azuzolo
parents:
diff changeset
22 --tree_path=$tree_path
003162f90751 Uploaded
azuzolo
parents:
diff changeset
23 #end if
003162f90751 Uploaded
azuzolo
parents:
diff changeset
24
003162f90751 Uploaded
azuzolo
parents:
diff changeset
25 </command>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
26 <inputs>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
27 <conditional name="run_type">
003162f90751 Uploaded
azuzolo
parents:
diff changeset
28 <param name="input_type" type="select" label="Input Type" help="Select the type/number of input file(s). If multiple rarefactions have been run, select Multiple File Alpha Diversity.">
003162f90751 Uploaded
azuzolo
parents:
diff changeset
29 <option value="single">Single File Alpha Diversity</option>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
30 <option value="multi" selected="true">Multiple File (batch) Alpha Diversity</option>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
31 </param>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
32 <when value="single">
003162f90751 Uploaded
azuzolo
parents:
diff changeset
33 <param name="input_path" type="data" format="txt" label="OTU table" help="Rarefied table for single file operation [REQUIRED]"/>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
34 </when>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
35 <when value="multi">
003162f90751 Uploaded
azuzolo
parents:
diff changeset
36 <param name="input_path" type="data" format="txt" label="Multiple Rarefactions Log File" help="multiple_rarefactions log file for multiple file operation. [REQUIRED]"/>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
37 </when>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
38 </conditional>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
39 <param name="metrics" type="select" multiple="true" label="metrics"
003162f90751 Uploaded
azuzolo
parents:
diff changeset
40 help="metrics to use">
003162f90751 Uploaded
azuzolo
parents:
diff changeset
41 <option value="ACE">ACE</option>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
42 <option value="berger_parker_d">berger_parker_d</option>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
43 <option value="brillouin_d">brillouin_d</option>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
44 <option value="chao1">chao1</option>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
45 <option value="chao1_confidence">chao1_confidence</option>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
46 <option value="dominance">dominance</option>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
47 <option value="doubles">doubles</option>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
48 <option value="equitability">equitability</option>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
49 <option value="fisher_alpha">fisher_alpha</option>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
50 <option value="heip_e">heip_e</option>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
51 <option value="kempton_taylor_q">kempton_taylor_q</option>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
52 <option value="margalef">margalef</option>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
53 <option value="mcintosh_d">mcintosh_d</option>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
54 <option value="mcintosh_e">mcintosh_e</option>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
55 <option value="menhinick">menhinick</option>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
56 <option value="michaelis_menten_fit">michaelis_menten_fit</option>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
57 <option value="observed_species">observed_species</option>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
58 <option value="osd">osd</option>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
59 <option value="reciprocal_simpson">reciprocal_simpson</option>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
60 <option value="robbins">robbins</option>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
61 <option value="shannon">shannon</option>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
62 <option value="simpson">simpson</option>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
63 <option value="simpson_e">simpson_e</option>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
64 <option value="singles">singles</option>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
65 <option value="strong">strong</option>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
66 <option value="PD_whole_tree">PD_whole_tree</option>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
67 </param>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
68 <param name="tree_path" type="data" format="tre" label="tree_path" optional="true"
003162f90751 Uploaded
azuzolo
parents:
diff changeset
69 help="path to newick tree file, REQUIRED for phylogenetic metrics: PD_whole_tree"/>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
70 </inputs>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
71 <outputs>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
72 <data format="txt" name="output_path" label="${tool.name} on ${on_string}: alpha_diversity log file"/>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
73 </outputs>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
74 <tests>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
75 </tests>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
76 <help>This tool calculates alpha diversity, or within-sample diversity, using an otu table. Metrics may be selected in any combination. Input can be the log file from multiple_rarefactions (batch alpha diversity), or a single rarefied OTU table (single_rarefaction/single file alpha diversity). When the phylogenetic metric PD_whole_tree is selected, a .tre file must be supplied for the tool to run. The output file is a log file listing all the alpha rarefaction files produced.
003162f90751 Uploaded
azuzolo
parents:
diff changeset
77
003162f90751 Uploaded
azuzolo
parents:
diff changeset
78 For more information, see alpha_diversity_ in the Qiime documentation.
003162f90751 Uploaded
azuzolo
parents:
diff changeset
79
003162f90751 Uploaded
azuzolo
parents:
diff changeset
80 Updated and validated 01/16/12 by Amanda Zuzolo, Microbiome Analysis Center, George Mason University, Fairfax, VA
003162f90751 Uploaded
azuzolo
parents:
diff changeset
81
003162f90751 Uploaded
azuzolo
parents:
diff changeset
82 Qiime integration courtesy Jim Johnson, Minnesota Supercomputing Institute, University of Minnesota, Minneapolis, MN
003162f90751 Uploaded
azuzolo
parents:
diff changeset
83
003162f90751 Uploaded
azuzolo
parents:
diff changeset
84 .. _alpha_diversity: http://qiime.org/scripts/alpha_diversity.html</help>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
85 </tool>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
86