annotate qiime2/qiime_diversity_beta-correlation.xml @ 4:914fa4daf16a draft

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