annotate qiime2/qiime_diversity_adonis.xml @ 6:de4c22a52df4 draft

Fixes
author florianbegusch
date Tue, 13 Aug 2019 07:46:48 -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_adonis" name="qiime diversity adonis" version="2019.4">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - adonis PERMANOVA test for beta group significance</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 adonis
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
9
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
10 --i-distance-matrix=$idistancematrix
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
11
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
12
2
51025741f326 Uploaded
florianbegusch
parents: 0
diff changeset
13 #if $input_files_mmetadatafile:
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
14 #def list_dict_to_string(list_dict):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
15 #set $file_list = list_dict[0]['additional_input'].__getattr__('file_name')
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
16 #for d in list_dict[1:]:
4
florianbegusch
parents: 2
diff changeset
17 #set $file_list = $file_list + ' --m-metadata-file=' + d['additional_input'].__getattr__('file_name')
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
18 #end for
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
19 #return $file_list
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
20 #end def
4
florianbegusch
parents: 2
diff changeset
21 --m-metadata-file=$list_dict_to_string($input_files_mmetadatafile)
2
51025741f326 Uploaded
florianbegusch
parents: 0
diff changeset
22 #end if
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
23
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
24
4
florianbegusch
parents: 2
diff changeset
25
florianbegusch
parents: 2
diff changeset
26 #if '__sq__' in str($pformula):
florianbegusch
parents: 2
diff changeset
27 #set $pformula_temp = $pformula.replace('__sq__', "'")
florianbegusch
parents: 2
diff changeset
28 #set $pformula = $pformula_temp
florianbegusch
parents: 2
diff changeset
29 #end if
florianbegusch
parents: 2
diff changeset
30
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
31 --p-formula="$pformula"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
32
4
florianbegusch
parents: 2
diff changeset
33
florianbegusch
parents: 2
diff changeset
34
6
florianbegusch
parents: 4
diff changeset
35 #if str($ppermutations):
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
36 --p-permutations=$ppermutations
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
37 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
38
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
39 #set $pnjobs = '${GALAXY_SLOTS:-4}'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
40 #if str($pnjobs):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
41 --p-n-jobs="$pnjobs"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
42 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
43
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
44 --o-visualization=ovisualization
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
45 ;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
46 qiime tools export --input-path ovisualization.qzv --output-path out && mkdir -p '$ovisualization.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
47 && cp -r out/* '$ovisualization.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
48 && mv '$ovisualization.files_path/index.html' '$ovisualization'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
49 ]]></command>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
50 <inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
51 <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
52 <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"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
53 <param label="--p-permutations: INTEGER Range(1, None) The number of permutations to be run when computing p-values. [default: 999]" name="ppermutations" optional="True" min="1" type="integer" value="999"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
54
4
florianbegusch
parents: 2
diff changeset
55 <repeat name="input_files_mmetadatafile" optional="False" title="--m-metadata-file [required]">
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
56 <param format="tabular" label="--m-metadata-file: Metadata file or artifact viewable as metadata. This option may be supplied multiple times to merge metadata. [required]" name="additional_input" type="data"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
57 </repeat>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
58 </inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
59 <outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
60 <data format="html" label="${tool.name} on ${on_string}: visualization.qzv" name="ovisualization"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
61 </outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
62 <help><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
63 adonis PERMANOVA test for beta group significance
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
64 #################################################
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
65
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
66 Determine whether groups of samples are significantly different from one
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
67 another using the ADONIS permutation-based statistical test in vegan-R. The
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
68 function partitions sums of squares of a multivariate data set, and is
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
69 directly analogous to MANOVA (multivariate analysis of variance). This
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
70 action differs from beta_group_signficance in that it accepts R formulae to
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
71 perform multi-way ADONIS tests; beta_group_signficance only performs one-
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
72 way tests. For more details see
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
73 http://cc.oulu.fi/~jarioksa/softhelp/vegan/html/adonis.html
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
74
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
75 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
76 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
77 distance_matrix : DistanceMatrix
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
78 Matrix of distances between pairs of samples.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
79 metadata : Metadata
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
80 Sample metadata containing formula terms.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
81 formula : Str
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
82 Model formula containing only independent terms contained in the sample
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
83 metadata. These can be continuous variables or factors, and they can
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
84 have interactions as in a typical R formula. E.g., the formula
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
85 "treatment+block" would test whether the input distance matrix
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
86 partitions based on "treatment" and "block" sample metadata. The
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
87 formula "treatment*block" would test both of those effects as well as
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
88 their interaction. Enclose formulae in quotes to avoid unpleasant
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
89 surprises.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
90 permutations : Int % Range(1, None), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
91 The number of permutations to be run when computing p-values.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
92
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
93 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
94 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
95 visualization : Visualization
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
96 ]]></help>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
97 <macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
98 <import>qiime_citation.xml</import>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
99 </macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
100 <expand macro="qiime_citation"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
101 </tool>