annotate compare_categories.xml @ 0:c1bd0c560018 draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
author bebatut
date Tue, 02 Feb 2016 05:50:37 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
1 <tool id="qiime_compare_categories" name="compare categories" version="1.9.1galaxy1">
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
2
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
3 <description>Analyzes statistical significance of sample groupings using
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
4 distance matrices</description>
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
5
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
6 <macros>
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
7 <import>macros.xml</import>
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
8 </macros>
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
9
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
10 <expand macro="requirements" />
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
11
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
12 <command>
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
13 <![CDATA[
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
14 compare_categories.py
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
15 --method=$method
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
16 -i $input_dm
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
17 -m $mapping_file
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
18 -c $categories
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
19 -o compare_categories_output
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
20 #if $num_permutations:
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
21 -n $num_permutations
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
22 #end if
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
23 ]]>
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
24 </command>
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
25
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
26 <inputs>
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
27 <param label="--method: the statistical method to use. Valid options:
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
28 adonis, anosim, bioenv, morans_i, mrpp, permanova, permdisp,
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
29 dbrda" name="method" optional="False" type="select">
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
30 <option value="adonis">adonis</option>
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
31 <option value="anosim">anosim</option>
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
32 <option value="bioenv">bioenv</option>
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
33 <option value="morans_i">morans_i</option>
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
34 <option value="mrpp">mrpp</option>
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
35 <option value="permanova">permanova</option>
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
36 <option value="permdisp">permdisp</option>
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
37 <option value="dbrda">dbrda</option>
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
38 </param>
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
39 <param label="-i/--input_dm: the input distance matrix. WARNING: Only
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
40 symmetric, hollow distance matrices may be used as input. Asymmetric
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
41 distance matrices, such as those obtained by the UniFrac Gain metric
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
42 (i.e. beta_diversity.py -m unifrac_g), should not be used as input"
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
43 name="input_dm" optional="False" type="data"/>
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
44 <param label="-m/--mapping_file: the metadata mapping file"
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
45 name="mapping_file" optional="False" type="data"/>
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
46 <param label="-c/--categories: a comma-delimited list of categories from
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
47 the mapping file. Note: all methods except for BIO-ENV accept just a
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
48 single category. If multiple categories are provided, only the first
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
49 will be used" name="categories" optional="False" type="text"/>
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
50 <param default="999" label="-n/--num_permutations: the number of permutations
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
51 to use when calculating statistical significance. Only applies to
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
52 adonis, ANOSIM, MRPP, PERMANOVA, PERMDISP, and db-RDA. Must be greater
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
53 than or equal to zero [default: 999]" name="num_permutations"
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
54 optional="True" type="integer"/>
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
55 </inputs>
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
56
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
57 <outputs>
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
58 <data format="txt" from_work_dir="compare_categories_output/*.txt"
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
59 name="output_dir" label="Compare_categories.txt"/>
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
60 </outputs>
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
61
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
62 <tests>
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
63 <test>
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
64 </test>
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
65 </tests>
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
66
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
67 <help><![CDATA[
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
68 **What it does**
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
69
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
70 This script allows for the analysis of the strength and statistical
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
71 significance of sample groupings using a distance matrix as the primary input.
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
72 Several statistical methods are available: adonis, ANOSIM, BIO-ENV, Moran's I,
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
73 MRPP, PERMANOVA, PERMDISP, and db-RDA.
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
74
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
75 Note: R's vegan and ape packages are used to compute many of these methods, and
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
76 for the ones that are not, their implementations are based on the
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
77 implementations found in those packages. It is recommended to read through the
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
78 detailed descriptions provided by the authors (they are not reproduced here)
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
79 and to refer to the primary literature for complete details, including the
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
80 methods' assumptions. To view the documentation of a method in R, prepend a
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
81 question mark before the method name. For example:
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
82
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
83 ?vegan::adonis
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
84
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
85 The following are brief descriptions of the available methods:
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
86
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
87 adonis - Partitions a distance matrix among sources of variation in order to
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
88 describe the strength and significance that a categorical or continuous
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
89 variable has in determining variation of distances. This is a nonparametric
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
90 method and is nearly equivalent to db-RDA (see below) except when distance
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
91 matrices constructed with semi-metric or non-metric dissimilarities are
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
92 provided, which may result in negative eigenvalues. adonis is very similar to
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
93 PERMANOVA, though it is more robust in that it can accept either categorical or
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
94 continuous variables in the metadata mapping file, while PERMANOVA can only
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
95 accept categorical variables. See vegan::adonis for more details.
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
96
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
97 ANOSIM - Tests whether two or more groups of samples are significantly
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
98 different based on a categorical variable found in the metadata mapping file.
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
99 You can specify a category in the metadata mapping file to separate
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
100 samples into groups and then test whether there are significant differences
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
101 between those groups. For example, you might test whether 'Control' samples are
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
102 significantly different from 'Fast' samples. Since ANOSIM is nonparametric,
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
103 significance is determined through permutations. See vegan::anosim for more
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
104 details.
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
105
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
106 BIO-ENV - Finds subsets of variables whose Euclidean distances (after scaling
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
107 the variables) are maximally rank-correlated with the distance matrix. For
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
108 example, the distance matrix might contain UniFrac distances between
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
109 communities, and the variables might be numeric environmental variables (e.g.,
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
110 pH and latitude). Correlation between the community distance matrix and
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
111 Euclidean environmental distance matrix is computed using Spearman's rank
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
112 correlation coefficient (rho). This method will only accept categories that are
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
113 numerical (continuous or discrete). This is currently the only method in the
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
114 script that accepts more than one category (via -c). See vegan::bioenv for more
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
115 details. This method is also known as BEST (previously called BIO-ENV) in the
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
116 PRIMER-E software package.
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
117
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
118 Moran's I - This method uses the numerical (e.g. geographical) data supplied to
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
119 identify what type of spatial configuration occurs in the samples. For example,
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
120 are they dispersed, clustered, or of no distinctly noticeable configuration
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
121 when compared to each other? This method will only accept a category that is
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
122 numerical. See ape::Moran.I for more details.
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
123
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
124 MRPP - This method tests whether two or more groups of samples are
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
125 significantly different based on a categorical variable found in the metadata
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
126 mapping file. You can specify a category in the metadata mapping file to
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
127 separate samples into groups and then test whether there are significant
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
128 differences between those groups. For example, you might test whether 'Control'
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
129 samples are significantly different from 'Fast' samples. Since MRPP is
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
130 nonparametric, significance is determined through permutations. See
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
131 vegan::mrpp for more details.
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
132
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
133 PERMANOVA - This method is very similar to adonis except that it only accepts a
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
134 categorical variable in the metadata mapping file. It uses an ANOVA
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
135 experimental design and returns a pseudo-F value and a p-value. Since PERMANOVA
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
136 is nonparametric, significance is determined through permutations.
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
137
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
138 PERMDISP - This method analyzes the multivariate homogeneity of group
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
139 dispersions (variances). In essence, it determines whether the variances of
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
140 groups of samples are significantly different. The results of both parametric
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
141 and nonparametric significance tests are provided in the output. This method is
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
142 generally used as a companion to PERMANOVA. See vegan::betadisper for more
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
143 details.
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
144
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
145 db-RDA - This method is very similar to adonis and will only differ if certain
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
146 non-Euclidean semi- or non-metrics are used to generate the input distance
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
147 matrix, and negative eigenvalues are encountered. The only difference then will
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
148 be in the p-values, not the R^2 values. As part of the output, an ordination
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
149 plot is also generated that shows grouping/clustering of samples based on a
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
150 category in the metadata mapping file. This category is used to explain the
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
151 variability between samples. Thus, the ordination output of db-RDA is similar
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
152 to PCoA except that it is constrained, while PCoA is unconstrained (i.e. with
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
153 db-RDA, you must specify which category should be used to explain the
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
154 variability in your data). See vegan::capscale for more details.
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
155
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
156 For more information and examples pertaining to this script, please refer to
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
157 the accompanying tutorial, which can be found at
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
158 http://qiime.org/tutorials/category_comparison.html.
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
159
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
160
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
161 At least one file will be created in the output directory specified by -o. For
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
162 most methods, a single output file containing the results of the test (e.g. the
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
163 effect size statistic and p-value) will be created. The format of the output
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
164 files will vary between methods as some are generated by native QIIME code,
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
165 while others are generated by R's vegan or ape packages. Please refer to the
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
166 script description for details on how to access additional information for
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
167 these methods, including what information is included in the output files.
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
168
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
169 db-RDA is the only exception in that two output files are created: a results
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
170 text file and a PDF of the ordination plot.
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
171 ]]>
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
172 </help>
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
173
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
174 <citations>
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
175 <expand macro="citations" />
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
176 </citations>
c1bd0c560018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime commit bcbe76277f3e60303faf826f8ce7f018bc663a9a-dirty
bebatut
parents:
diff changeset
177 </tool>