annotate qiime2/qiime_diversity_adonis.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_adonis" name="qiime diversity adonis"
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
3 version="2020.8">
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
4 <description>adonis PERMANOVA test for beta 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 adonis
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 --p-formula=$pformula
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
24
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
25 --p-permutations=$ppermutations
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
26
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
27 --p-n-jobs=$pnjobs
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
28
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
29 --o-visualization=ovisualization
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
30
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
31 #if str($examples) != 'None':
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
32 --examples=$examples
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
33 #end if
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
34
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
35 ;
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
36 cp osubsampledsequences.qza $osubsampledsequences
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
37
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
38 ;
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
39 qiime tools export ovisualization.qzv --output-path out
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
40 && mkdir -p '$ovisualization.files_path'
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
41 && cp -r out/* '$ovisualization.files_path'
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
42 && mv '$ovisualization.files_path/index.html' '$ovisualization'
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
43
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
44 ;
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
45 qiime tools export ovisualization.qzv --output-path out
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
46 && mkdir -p '$ovisualization.files_path'
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
47 && cp -r out/* '$ovisualization.files_path'
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
48 && mv '$ovisualization.files_path/index.html' '$ovisualization'
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
49
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
50 ]]></command>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
51 <inputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
52 <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
53 <repeat name="input_files_mmetadatafile" optional="False" title="--m-metadata-file">
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
54 <param format="tabular,qza,no_unzip.zip" label="--m-metadata-file: METADATA... (multiple Sample metadata containing formula terms. arguments will be merged) [required]" name="additional_input" optional="False" type="data" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
55 </repeat>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
56 <param label="--p-formula: TEXT Model formula containing only independent terms contained in the sample metadata. These can be continuous variables or factors, and they can have interactions as in a typical R formula. E.g., the formula \'treatment+block\' would test whether the input distance matrix partitions based on \'treatment\' and \'block\' sample metadata. The formula \'treatment*block\' would test both of those effects as well as their interaction. Enclose formulae in quotes to avoid unpleasant surprises. [required]" name="pformula" optional="False" type="text" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
57 <param label="--p-permutations: INTEGER Range(1, None) The number of permutations to be run when computing p-values. [default: 999]" min="1" name="ppermutations" optional="True" type="integer" value="999" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
58 <param label="--examples: Show usage examples and exit." name="examples" optional="False" type="data" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
59
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
60 </inputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
61
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
62 <outputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
63 <data format="html" label="${tool.name} on ${on_string}: visualization.html" name="ovisualization" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
64
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
65 </outputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
66
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
67 <help><![CDATA[
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
68 adonis PERMANOVA test for beta group significance
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
69 ###############################################################
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
70
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
71 Determine whether groups of samples are significantly different from one
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
72 another using the ADONIS permutation-based statistical test in vegan-R. The
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
73 function partitions sums of squares of a multivariate data set, and is
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
74 directly analogous to MANOVA (multivariate analysis of variance). This
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
75 action differs from beta_group_significance in that it accepts R formulae
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
76 to perform multi-way ADONIS tests; beta_group_signficance only performs
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
77 one-way tests. For more details see
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
78 http://cc.oulu.fi/~jarioksa/softhelp/vegan/html/adonis.html
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
79
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
80 Parameters
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
81 ----------
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
82 distance_matrix : DistanceMatrix
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
83 Matrix of distances between pairs of samples.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
84 metadata : Metadata
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
85 Sample metadata containing formula terms.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
86 formula : Str
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
87 Model formula containing only independent terms contained in the sample
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
88 metadata. These can be continuous variables or factors, and they can
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
89 have interactions as in a typical R formula. E.g., the formula
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
90 "treatment+block" would test whether the input distance matrix
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
91 partitions based on "treatment" and "block" sample metadata. The
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
92 formula "treatment*block" would test both of those effects as well as
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
93 their interaction. Enclose formulae in quotes to avoid unpleasant
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
94 surprises.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
95 permutations : Int % Range(1, None), optional
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
96 The number of permutations to be run when computing p-values.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
97 n_jobs : Int % Range(1, None), optional
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
98 Number of parallel processes to run.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
99
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
100 Returns
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
101 -------
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
102 visualization : Visualization
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
103 ]]></help>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
104 <macros>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
105 <import>qiime_citation.xml</import>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
106 </macros>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
107 <expand macro="qiime_citation"/>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
108 </tool>