annotate qiime2/qiime_diversity_mantel.xml @ 7:85b520815e85 draft

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