annotate qiime2/qiime_diversity_beta-group-significance.xml @ 10:21c7954105a9 draft

Fix
author florianbegusch
date Sun, 25 Aug 2019 10:26:27 -0400
parents f190567fe3f6
children a0a8d77a991c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
1 <?xml version="1.0" ?>
9
f190567fe3f6 Uploaded
florianbegusch
parents: 6
diff changeset
2 <tool id="qiime_diversity_beta-group-significance" name="qiime diversity beta-group-significance" version="2019.7">
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Beta diversity group significance</description>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
4 <requirements>
9
f190567fe3f6 Uploaded
florianbegusch
parents: 6
diff changeset
5 <requirement type="package" version="2019.7">qiime2</requirement>
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
6 </requirements>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
7 <command><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
8 qiime diversity beta-group-significance
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
9
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
10 --i-distance-matrix=$idistancematrix
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
11 --m-metadata-column="$mmetadatacolumn"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
12
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
13
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
14
6
florianbegusch
parents: 4
diff changeset
15 #if $metadatafile:
florianbegusch
parents: 4
diff changeset
16 --m-metadata-file=$metadatafile
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
17 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
18
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
19
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
20 #if str($pmethod) != 'None':
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
21 --p-method=$pmethod
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
22 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
23
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
24 #if $ppairwise:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
25 --p-pairwise
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
26 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
27
6
florianbegusch
parents: 4
diff changeset
28 #if str($ppermutations):
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
29 --p-permutations=$ppermutations
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
30 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
31
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
32 --o-visualization=ovisualization
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
33 ;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
34 qiime tools export --input-path ovisualization.qzv --output-path out && mkdir -p '$ovisualization.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
35 && cp -r out/* '$ovisualization.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
36 && mv '$ovisualization.files_path/index.html' '$ovisualization'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
37 ]]></command>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
38 <inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
39 <param format="qza,no_unzip.zip" label="--i-distance-matrix: ARTIFACT DistanceMatrix Matrix of distances between pairs of samples. [required]" name="idistancematrix" optional="False" type="data"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
40 <param label="--m-metadata-column: COLUMN MetadataColumn[Categorical] Categorical sample metadata column. [required]" name="mmetadatacolumn" optional="False" type="text"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
41 <param label="--p-method: " name="pmethod" optional="True" type="select">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
42 <option selected="True" value="None">Selection is Optional</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
43 <option value="permanova">permanova</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
44 <option value="anosim">anosim</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
45 <option value="permdisp">permdisp</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
46 </param>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
47 <param label="--p-pairwise: --p-no-pairwise Perform pairwise tests between all pairs of groups in addition to the test across all groups. This can be very slow if there are a lot of groups in the metadata column. [default: False]" name="ppairwise" selected="False" type="boolean"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
48 <param label="--p-permutations: INTEGER The number of permutations to be run when computing p-values. [default: 999]" name="ppermutations" optional="True" type="integer" value="999"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
49
6
florianbegusch
parents: 4
diff changeset
50 <param label="--m-metadata-file METADATA [required]" name="metadatafile" type="data" format="tabular,qza,no_unzip.zip" optional="False" />
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
51 </inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
52 <outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
53 <data format="html" label="${tool.name} on ${on_string}: visualization.qzv" name="ovisualization"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
54 </outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
55 <help><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
56 Beta diversity group significance
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
57 #################################
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
58
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
59 Determine whether groups of samples are significantly different from one
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
60 another using a permutation-based statistical test.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
61
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
62 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
63 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
64 distance_matrix : DistanceMatrix
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
65 Matrix of distances between pairs of samples.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
66 metadata : MetadataColumn[Categorical]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
67 Categorical sample metadata column.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
68 method : Str % Choices('permanova', 'anosim', 'permdisp'), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
69 The group significance test to be applied.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
70 pairwise : Bool, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
71 Perform pairwise tests between all pairs of groups in addition to the
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
72 test across all groups. This can be very slow if there are a lot of
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
73 groups in the metadata column.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
74 permutations : Int, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
75 The number of permutations to be run when computing p-values.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
76
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
77 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
78 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
79 visualization : Visualization
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
80 ]]></help>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
81 <macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
82 <import>qiime_citation.xml</import>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
83 </macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
84 <expand macro="qiime_citation"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
85 </tool>