annotate qiime2-2020.8/qiime_diversity_mantel.xml @ 22:292c84bd5ab6 draft

Uploaded
author florianbegusch
date Fri, 04 Sep 2020 12:55:05 +0000
parents d93d8888f0b0
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
20
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
1 <?xml version="1.0" ?>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
2 <tool id="qiime_diversity_mantel" name="qiime diversity mantel"
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
3 version="2020.8">
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
4 <description>Apply the Mantel test to two distance matrices</description>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
5 <requirements>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
6 <requirement type="package" version="2020.8">qiime2</requirement>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
7 </requirements>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
8 <command><![CDATA[
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
9 qiime diversity mantel
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
10
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
11 --i-dm1=$idm1
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
12
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
13 --i-dm2=$idm2
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
14
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
15 #if str($pmethod) != 'None':
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
16 --p-method=$pmethod
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
17 #end if
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
18
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
19 --p-permutations=$ppermutations
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
20
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
21 #if $pintersectids:
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
22 --p-intersect-ids
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
23 #end if
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
24
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
25 #if str($plabel1):
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
26 --p-label1=$plabel1
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
27 #end if
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
28 #if str($plabel2):
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
29 --p-label2=$plabel2
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
30 #end if
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
31 --o-visualization=ovisualization
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
32
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
33 #if str($examples) != 'None':
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
34 --examples=$examples
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
35 #end if
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
36
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
37 ;
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
38 cp ofiltereddistancematrix.qza $ofiltereddistancematrix
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
39
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
40 ;
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
41 qiime tools export ovisualization.qzv --output-path out
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
42 && mkdir -p '$ovisualization.files_path'
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
43 && cp -r out/* '$ovisualization.files_path'
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
44 && mv '$ovisualization.files_path/index.html' '$ovisualization'
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
45
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
46 ]]></command>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
47 <inputs>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
48 <param format="qza,no_unzip.zip" label="--i-dm1: ARTIFACT Matrix of distances between pairs of samples. DistanceMatrix [required]" name="idm1" optional="False" type="data" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
49 <param format="qza,no_unzip.zip" label="--i-dm2: ARTIFACT Matrix of distances between pairs of samples. DistanceMatrix [required]" name="idm2" optional="False" type="data" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
50 <param label="--p-method: " name="pmethod" optional="True" type="select">
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
51 <option selected="True" value="None">Selection is Optional</option>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
52 <option value="spearman">spearman</option>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
53 <option value="pearson">pearson</option>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
54 </param>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
55 <param label="--p-permutations: INTEGER Range(0, None) The number of permutations to be run when computing p-values. Supplying a value of zero will disable permutation testing and p-values will not be calculated (this results in *much* quicker execution time if p-values are not desired). [default: 999]" min="0" name="ppermutations" optional="True" type="integer" value="999" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
56 <param label="--p-intersect-ids: --p-intersect-ids: / --p-no-intersect-ids If supplied, IDs that are not found in both distance matrices will be discarded before applying the Mantel test. Default behavior is to error on any mismatched IDs. [default: False]" name="pintersectids" selected="False" type="boolean" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
57 <param label="--p-label1: TEXT Label for `dm1` in the output visualization. [default: \'Distance Matrix 1\']" name="plabel1" optional="False" type="text" value="\'Distance Matrix 1\'" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
58 <param label="--p-label2: TEXT Label for `dm2` in the output visualization. [default: \'Distance Matrix 2\']" name="plabel2" optional="False" type="text" value="\'Distance Matrix 2\'" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
59 <param label="--examples: Show usage examples and exit." name="examples" optional="False" type="data" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
60
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
61 </inputs>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
62
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
63 <outputs>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
64 <data format="html" label="${tool.name} on ${on_string}: visualization.html" name="ovisualization" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
65
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
66 </outputs>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
67
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
68 <help><![CDATA[
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
69 Apply the Mantel test to two distance matrices
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
70 ###############################################################
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
71
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
72 Apply a two-sided Mantel test to identify correlation between two distance
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
73 matrices. Note: the directionality of the comparison has no bearing on the
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
74 results. Thus, comparing distance matrix X to distance matrix Y is
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
75 equivalent to comparing Y to X. Note: the order of samples within the two
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
76 distance matrices does not need to be the same; the distance matrices will
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
77 be reordered before applying the Mantel test. See the scikit-bio docs for
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
78 more details about the Mantel test: http://scikit-
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
79 bio.org/docs/latest/generated/skbio.stats.distance.mantel
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
80
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
81 Parameters
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
82 ----------
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
83 dm1 : DistanceMatrix
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
84 Matrix of distances between pairs of samples.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
85 dm2 : DistanceMatrix
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
86 Matrix of distances between pairs of samples.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
87 method : Str % Choices('spearman', 'pearson'), optional
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
88 The correlation test to be applied in the Mantel test.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
89 permutations : Int % Range(0, None), optional
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
90 The number of permutations to be run when computing p-values. Supplying
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
91 a value of zero will disable permutation testing and p-values will not
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
92 be calculated (this results in *much* quicker execution time if
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
93 p-values are not desired).
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
94 intersect_ids : Bool, optional
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
95 If supplied, IDs that are not found in both distance matrices will be
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
96 discarded before applying the Mantel test. Default behavior is to error
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
97 on any mismatched IDs.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
98 label1 : Str, optional
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
99 Label for `dm1` in the output visualization.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
100 label2 : Str, optional
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
101 Label for `dm2` in the output visualization.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
102
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
103 Returns
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
104 -------
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
105 visualization : Visualization
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
106 ]]></help>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
107 <macros>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
108 <import>qiime_citation.xml</import>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
109 </macros>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
110 <expand macro="qiime_citation"/>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
111 </tool>