annotate qiime2/qiime_diversity_beta-group-significance.xml @ 29:3ba9833030c1 draft

Uploaded
author florianbegusch
date Fri, 04 Sep 2020 13:12:49 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
29
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
1 <?xml version="1.0" ?>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
2 <tool id="qiime_diversity_beta-group-significance" name="qiime diversity beta-group-significance"
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
3 version="2020.8">
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
4 <description>Beta diversity group significance</description>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
5 <requirements>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
6 <requirement type="package" version="2020.8">qiime2</requirement>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
7 </requirements>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
8 <command><![CDATA[
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
9 qiime diversity beta-group-significance
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
10
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
11 --i-distance-matrix=$idistancematrix
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
12 # if $input_files_mmetadatafile:
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
13 # def list_dict_to_string(list_dict):
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
14 # set $file_list = list_dict[0]['additional_input'].__getattr__('file_name')
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
15 # for d in list_dict[1:]:
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
16 # set $file_list = $file_list + ' --m-metadata-file=' + d['additional_input'].__getattr__('file_name')
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
17 # end for
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
18 # return $file_list
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
19 # end def
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
20 --m-metadata-file=$list_dict_to_string($input_files_mmetadatafile)
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
21 # end if
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
22
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
23 #if '__ob__' in str($mmetadatacolumn):
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
24 #set $mmetadatacolumn_temp = $mmetadatacolumn.replace('__ob__', '[')
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
25 #set $mmetadatacolumn = $mmetadatacolumn_temp
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
26 #end if
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
27 #if '__cb__' in str($mmetadatacolumn):
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
28 #set $mmetadatacolumn_temp = $mmetadatacolumn.replace('__cb__', ']')
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
29 #set $mmetadatacolumn = $mmetadatacolumn_temp
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
30 #end if
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
31 #if 'X' in str($mmetadatacolumn):
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
32 #set $mmetadatacolumn_temp = $mmetadatacolumn.replace('X', '\\')
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
33 #set $mmetadatacolumn = $mmetadatacolumn_temp
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
34 #end if
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
35 #if '__sq__' in str($mmetadatacolumn):
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
36 #set $mmetadatacolumn_temp = $mmetadatacolumn.replace('__sq__', "'")
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
37 #set $mmetadatacolumn = $mmetadatacolumn_temp
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
38 #end if
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
39 #if '__db__' in str($mmetadatacolumn):
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
40 #set $mmetadatacolumn_temp = $mmetadatacolumn.replace('__db__', '"')
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
41 #set $mmetadatacolumn = $mmetadatacolumn_temp
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
42 #end if
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
43
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
44 --m-metadata-column=$mmetadatacolumn
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
45
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
46
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
47 #if str($pmethod) != 'None':
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
48 --p-method=$pmethod
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
49 #end if
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
50
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
51 #if $ppairwise:
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
52 --p-pairwise
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
53 #end if
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
54
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
55 --p-permutations=$ppermutations
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
56
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
57 --o-visualization=ovisualization
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
58
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
59 #if str($examples) != 'None':
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
60 --examples=$examples
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
61 #end if
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
62
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
63 ;
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
64 cp odistancematrix.qza $odistancematrix
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
65
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
66 ;
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
67 qiime tools export omantelscattervisualization.qzv --output-path out
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
68 && mkdir -p '$omantelscattervisualization.files_path'
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
69 && cp -r out/* '$omantelscattervisualization.files_path'
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
70 && mv '$omantelscattervisualization.files_path/index.html' '$omantelscattervisualization'
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
71
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
72 ;
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
73 qiime tools export ovisualization.qzv --output-path out
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
74 && mkdir -p '$ovisualization.files_path'
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
75 && cp -r out/* '$ovisualization.files_path'
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
76 && mv '$ovisualization.files_path/index.html' '$ovisualization'
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
77
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
78 ]]></command>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
79 <inputs>
3ba9833030c1 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" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
81 <repeat name="input_files_mmetadatafile" optional="True" title="--m-metadata-file">
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
82 <param format="tabular,qza,no_unzip.zip" label="--m-metadata-file: METADATA" name="additional_input" optional="True" type="data" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
83 </repeat>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
84 <param label="--m-metadata-column: COLUMN MetadataColumn[Categorical] Categorical sample metadata column. [required]" name="mmetadatacolumn" optional="False" type="text" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
85 <param label="--p-method: " name="pmethod" optional="True" type="select">
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
86 <option selected="True" value="None">Selection is Optional</option>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
87 <option value="permanova">permanova</option>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
88 <option value="anosim">anosim</option>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
89 <option value="permdisp">permdisp</option>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
90 </param>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
91 <param label="--p-pairwise: --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" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
92 <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" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
93 <param label="--examples: Show usage examples and exit." name="examples" optional="False" type="data" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
94
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
95 </inputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
96
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
97 <outputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
98 <data format="html" label="${tool.name} on ${on_string}: visualization.html" name="ovisualization" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
99
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
100 </outputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
101
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
102 <help><![CDATA[
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
103 Beta diversity group significance
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
104 ###############################################################
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
105
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
106 Determine whether groups of samples are significantly different from one
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
107 another using a permutation-based statistical test.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
108
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
109 Parameters
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
110 ----------
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
111 distance_matrix : DistanceMatrix
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
112 Matrix of distances between pairs of samples.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
113 metadata : MetadataColumn[Categorical]
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
114 Categorical sample metadata column.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
115 method : Str % Choices('permanova', 'anosim', 'permdisp'), optional
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
116 The group significance test to be applied.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
117 pairwise : Bool, optional
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
118 Perform pairwise tests between all pairs of groups in addition to the
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
119 test across all groups. This can be very slow if there are a lot of
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
120 groups in the metadata column.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
121 permutations : Int, optional
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
122 The number of permutations to be run when computing p-values.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
123
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
124 Returns
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
125 -------
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
126 visualization : Visualization
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
127 ]]></help>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
128 <macros>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
129 <import>qiime_citation.xml</import>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
130 </macros>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
131 <expand macro="qiime_citation"/>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
132 </tool>