annotate qiime_diversity_beta-group-significance.xml @ 0:09b7bcb72fa7 draft

Uploaded
author florianbegusch
date Thu, 24 May 2018 02:11:44 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
1 <?xml version="1.0" ?>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
2 <tool id="qiime_diversity_beta-group-significance" name="qiime diversity beta-group-significance" version="2018.4">
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Beta diversity group significance</description>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
4 <requirements>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
5 <requirement type="package" version="2018.4">qiime2</requirement>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
6 </requirements>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
7 <command><![CDATA[
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
8 qiime diversity beta-group-significance --i-distance-matrix=$idistancematrix
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
9
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
10 #def list_dict_to_string(list_dict):
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
11 #set $file_list = list_dict[0]['additional_input'].__getattr__('file_name')
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
12 #for d in list_dict[1:]:
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
13 #set $file_list = $file_list + ',' + d['additional_input'].__getattr__('file_name')
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
14 #end for
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
15 #return $file_list
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
16 #end def
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
17
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
18 --m-metadata-file=$list_dict_to_string($input_files_mmetadatafile) --m-metadata-column="$mmetadatacolumn"
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
19
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
20 #if $ppairwise:
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
21 --p-pairwise
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
22 #else
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
23 --p-no-pairwise
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
24 #end if
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
25
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
26 --o-visualization=ovisualization
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
27
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
28 #if str($cmdconfig) != 'None':
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
29 --cmd-config=$cmdconfig
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
30 #end if
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
31
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
32 #if str($pmethod) != 'None':
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
33 --p-method=$pmethod
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
34 #end if
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
35
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
36 #if $ppermutations:
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
37 --p-permutations=$ppermutations
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
38 #end if
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
39 ;
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
40
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
41 qiime tools export ovisualization.qzv --output-dir out && mkdir -p '$ovisualization.files_path'
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
42 && cp -r out/* '$ovisualization.files_path'
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
43 && mv '$ovisualization.files_path/index.html' '$ovisualization';
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
44 ]]></command>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
45 <inputs>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
46 <param format="qza,no_unzip.zip" label="--i-distance-matrix: DistanceMatrix Matrix of distances between pairs of samples. [required]" name="idistancematrix" optional="False" type="data"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
47 <repeat name="input_files_mmetadatafile" optional="False" title="--m-metadata-file">
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
48 <param 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" format="tabular,qza,no_unzip.zip" />
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
49 </repeat>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
50 <param label="--m-metadata-column: MetadataColumn[Categorical] Column from metadata file or artifact viewable as metadata. Categorical sample metadata column. [required]" name="mmetadatacolumn" optional="False" type="text"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
51 <param label="--p-method: " name="pmethod" optional="True" type="select">
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
52 <option selected="True" value="None">Selection is Optional</option>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
53 <option value="anosim">anosim</option>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
54 <option value="permanova">permanova</option>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
55 </param>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
56 <param label="--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" checked="False" type="boolean"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
57 <param label="--p-permutations: The number of permutations to be run when computing p-values. [default: 999]" name="ppermutations" optional="True" type="integer" value="999"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
58 <param label="--cmd-config: Use config file for command options" name="cmdconfig" optional="True" type="data"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
59 </inputs>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
60 <outputs>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
61 <data format="html" label="${tool.name} on ${on_string}: visualization.qzv" name="ovisualization"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
62 </outputs>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
63 <help><![CDATA[
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
64 Beta diversity group significance
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
65 ---------------------------------
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
66
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
67 Determine whether groups of samples are significantly different from one
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
68 another using a permutation-based statistical test.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
69
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
70 Parameters
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
71 ----------
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
72 distance_matrix : DistanceMatrix
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
73 Matrix of distances between pairs of samples.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
74 metadata : MetadataColumn[Categorical]
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
75 Categorical sample metadata column.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
76 method : Str % Choices({'anosim', 'permanova'}), optional
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
77 The group significance test to be applied.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
78 pairwise : Bool, optional
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
79 Perform pairwise tests between all pairs of groups in addition to the
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
80 test across all groups. This can be very slow if there are a lot of
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
81 groups in the metadata column.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
82 permutations : Int, optional
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
83 The number of permutations to be run when computing p-values.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
84
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
85 Returns
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
86 -------
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
87 visualization : Visualization
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
88 \
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
89 ]]>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
90 </help>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
91 </tool>