|
0
|
1 <?xml version="1.0" ?>
|
|
|
2 <tool id="qiime_diversity_beta-correlation" name="qiime diversity beta-correlation" version="2019.4">
|
|
|
3 <description> - Beta diversity correlation</description>
|
|
|
4 <requirements>
|
|
|
5 <requirement type="package" version="2019.4">qiime2</requirement>
|
|
|
6 </requirements>
|
|
|
7 <command><![CDATA[
|
|
|
8 qiime diversity beta-correlation
|
|
|
9
|
|
|
10 --i-distance-matrix=$idistancematrix
|
|
4
|
11
|
|
|
12
|
|
|
13
|
|
|
14 #if '__sq__' in str($mmetadatacolumn):
|
|
|
15 #set $mmetadatacolumn_temp = $mmetadatacolumn.replace('__sq__', "'")
|
|
|
16 #set $mmetadatacolumn = $mmetadatacolumn_temp
|
|
|
17 #end if
|
|
|
18
|
|
0
|
19 --m-metadata-column="$mmetadatacolumn"
|
|
|
20
|
|
4
|
21
|
|
|
22
|
|
0
|
23 #if str($pmethod) != 'None':
|
|
|
24 --p-method=$pmethod
|
|
|
25 #end if
|
|
|
26
|
|
6
|
27 #if str($ppermutations):
|
|
0
|
28 --p-permutations=$ppermutations
|
|
|
29 #end if
|
|
|
30
|
|
6
|
31 #if str($pintersectids):
|
|
0
|
32 --p-intersect-ids
|
|
|
33 #end if
|
|
|
34
|
|
4
|
35
|
|
|
36
|
|
|
37
|
|
|
38 #if '__sq__' in str($plabel1):
|
|
|
39 #set $plabel1_temp = $plabel1.replace('__sq__', "'")
|
|
|
40 #set $plabel1 = $plabel1_temp
|
|
|
41 #end if
|
|
|
42
|
|
0
|
43 #if str($plabel1):
|
|
|
44 --p-label1="$plabel1"
|
|
|
45 #end if
|
|
|
46
|
|
4
|
47
|
|
|
48
|
|
|
49 #if '__sq__' in str($plabel2):
|
|
|
50 #set $plabel2_temp = $plabel2.replace('__sq__', "'")
|
|
|
51 #set $plabel2 = $plabel2_temp
|
|
|
52 #end if
|
|
|
53
|
|
0
|
54 #if str($plabel2):
|
|
|
55 --p-label2="$plabel2"
|
|
|
56 #end if
|
|
|
57
|
|
4
|
58
|
|
|
59
|
|
6
|
60 #if $metadatafile:
|
|
|
61 --m-metadata-file=$metadatafile
|
|
0
|
62 #end if
|
|
|
63
|
|
6
|
64
|
|
|
65
|
|
|
66
|
|
0
|
67 --o-metadata-distance-matrix=ometadatadistancematrix
|
|
|
68 --o-mantel-scatter-visualization=omantelscattervisualization
|
|
|
69 ;
|
|
|
70 cp ometadatadistancematrix.qza $ometadatadistancematrix;
|
|
|
71 qiime tools export --input-path omantelscattervisualization.qzv --output-path out && mkdir -p '$omantelscattervisualization.files_path'
|
|
|
72 && cp -r out/* '$omantelscattervisualization.files_path'
|
|
|
73 && mv '$omantelscattervisualization.files_path/index.html' '$omantelscattervisualization'
|
|
|
74 ]]></command>
|
|
|
75 <inputs>
|
|
|
76 <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"/>
|
|
|
77 <param label="--m-metadata-column: COLUMN MetadataColumn[Numeric] Numeric metadata column from which to compute pairwise Euclidean distances [required]" name="mmetadatacolumn" optional="False" type="text"/>
|
|
|
78 <param label="--p-method: " name="pmethod" optional="True" type="select">
|
|
|
79 <option selected="True" value="None">Selection is Optional</option>
|
|
|
80 <option value="spearman">spearman</option>
|
|
|
81 <option value="pearson">pearson</option>
|
|
|
82 </param>
|
|
|
83 <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"/>
|
|
|
84 <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
|
85 <param label="--p-label1: TEXT Label for `distance-matrix` in the output visualization. [default: 'Metadata']" name="plabel1" optional="True" type="text" value="Metadata"/>
|
|
|
86 <param label="--p-label2: TEXT Label for `metadata-distance-matrix` in the output visualization. [default: 'Distance Matrix']" name="plabel2" optional="True" type="text" value="Distance Matrix"/>
|
|
6
|
87
|
|
|
88 <param label="--m-metadata-file METADATA" name="metadatafile" type="data" format="tabular,qza,no_unzip.zip" optional="True" />
|
|
|
89
|
|
0
|
90 </inputs>
|
|
|
91 <outputs>
|
|
|
92 <data format="qza" label="${tool.name} on ${on_string}: metadatadistancematrix.qza" name="ometadatadistancematrix"/>
|
|
|
93 <data format="html" label="${tool.name} on ${on_string}: mantelscattervisualization.qzv" name="omantelscattervisualization"/>
|
|
|
94 </outputs>
|
|
|
95 <help><![CDATA[
|
|
|
96 Beta diversity correlation
|
|
|
97 ##########################
|
|
|
98
|
|
|
99 Create a distance matrix from a numeric metadata column and apply a two-
|
|
|
100 sided Mantel test to identify correlation between two distance matrices.
|
|
|
101 Actions used internally: `distance-matrix` from q2-metadata and `mantel`
|
|
|
102 from q2-diversity.
|
|
|
103
|
|
|
104 Parameters
|
|
|
105 ----------
|
|
|
106 metadata : MetadataColumn[Numeric]
|
|
|
107 Numeric metadata column from which to compute pairwise Euclidean
|
|
|
108 distances
|
|
|
109 distance_matrix : DistanceMatrix
|
|
|
110 Matrix of distances between pairs of samples.
|
|
|
111 method : Str % Choices('spearman', 'pearson'), optional
|
|
|
112 The correlation test to be applied in the Mantel test.
|
|
|
113 permutations : Int % Range(0, None), optional
|
|
|
114 The number of permutations to be run when computing p-values. Supplying
|
|
|
115 a value of zero will disable permutation testing and p-values will not
|
|
|
116 be calculated (this results in *much* quicker execution time if
|
|
|
117 p-values are not desired).
|
|
|
118 intersect_ids : Bool, optional
|
|
|
119 If supplied, IDs that are not found in both distance matrices will be
|
|
|
120 discarded before applying the Mantel test. Default behavior is to error
|
|
|
121 on any mismatched IDs.
|
|
|
122 label1 : Str, optional
|
|
|
123 Label for `distance_matrix` in the output visualization.
|
|
|
124 label2 : Str, optional
|
|
|
125 Label for `metadata_distance_matrix` in the output visualization.
|
|
|
126
|
|
|
127 Returns
|
|
|
128 -------
|
|
|
129 metadata_distance_matrix : DistanceMatrix
|
|
|
130 The Distance Matrix produced from the metadata column and used in the
|
|
|
131 mantel test
|
|
|
132 mantel_scatter_visualization : Visualization
|
|
|
133 Scatter plot rendering of the manteltest results
|
|
|
134 ]]></help>
|
|
|
135 <macros>
|
|
|
136 <import>qiime_citation.xml</import>
|
|
|
137 </macros>
|
|
|
138 <expand macro="qiime_citation"/>
|
|
|
139 </tool>
|
