annotate qiime2-2020.8/qiime_diversity_alpha-correlation.xml @ 20:d93d8888f0b0 draft

Uploaded
author florianbegusch
date Fri, 04 Sep 2020 12:44:24 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
20
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
1 <?xml version="1.0" ?>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
2 <tool id="qiime_diversity_alpha-correlation" name="qiime diversity alpha-correlation"
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
3 version="2020.8">
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
4 <description>Alpha diversity correlation</description>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
5 <requirements>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
6 <requirement type="package" version="2020.8">qiime2</requirement>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
7 </requirements>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
8 <command><![CDATA[
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
9 qiime diversity alpha-correlation
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
10
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
11 --i-alpha-diversity=$ialphadiversity
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
12 # if $input_files_mmetadatafile:
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
13 # def list_dict_to_string(list_dict):
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
14 # set $file_list = list_dict[0]['additional_input'].__getattr__('file_name')
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
15 # for d in list_dict[1:]:
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
16 # set $file_list = $file_list + ' --m-metadata-file=' + d['additional_input'].__getattr__('file_name')
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
17 # end for
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
18 # return $file_list
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
19 # end def
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
20 --m-metadata-file=$list_dict_to_string($input_files_mmetadatafile)
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
21 # end if
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
22
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
23 #if str($pmethod) != 'None':
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
24 --p-method=$pmethod
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
25 #end if
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
26
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
27 #if $pintersectids:
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
28 --p-intersect-ids
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
29 #end if
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
30
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
31 --o-visualization=ovisualization
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
32
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
33 #if str($examples) != 'None':
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
34 --examples=$examples
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
35 #end if
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
36
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
37 ;
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
38 cp oalphadiversity.qza $oalphadiversity
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
39
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
40 ;
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
41 qiime tools export ovisualization.qzv --output-path out
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
42 && mkdir -p '$ovisualization.files_path'
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
43 && cp -r out/* '$ovisualization.files_path'
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
44 && mv '$ovisualization.files_path/index.html' '$ovisualization'
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
45
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
46 ]]></command>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
47 <inputs>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
48 <param format="qza,no_unzip.zip" label="--i-alpha-diversity: ARTIFACT SampleData[AlphaDiversity] Vector of alpha diversity values by sample. [required]" name="ialphadiversity" optional="False" type="data" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
49 <repeat name="input_files_mmetadatafile" optional="False" title="--m-metadata-file">
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
50 <param format="tabular,qza,no_unzip.zip" label="--m-metadata-file: METADATA... (multiple The sample metadata. arguments will be merged) [required]" name="additional_input" optional="False" type="data" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
51 </repeat>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
52 <param label="--p-method: " name="pmethod" optional="True" type="select">
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
53 <option selected="True" value="None">Selection is Optional</option>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
54 <option value="spearman">spearman</option>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
55 <option value="pearson">pearson</option>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
56 </param>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
57 <param label="--p-intersect-ids: --p-intersect-ids: / --p-no-intersect-ids If supplied, IDs that are not found in both the alpha diversity vector and metadata will be discarded before calculating the correlation. Default behavior is to error on any mismatched IDs. [default: False]" name="pintersectids" selected="False" type="boolean" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
58 <param label="--examples: Show usage examples and exit." name="examples" optional="False" type="data" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
59
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
60 </inputs>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
61
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
62 <outputs>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
63 <data format="html" label="${tool.name} on ${on_string}: visualization.html" name="ovisualization" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
64
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
65 </outputs>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
66
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
67 <help><![CDATA[
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
68 Alpha diversity correlation
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
69 ###############################################################
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
70
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
71 Determine whether numeric sample metadata columns are correlated with alpha
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
72 diversity.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
73
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
74 Parameters
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
75 ----------
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
76 alpha_diversity : SampleData[AlphaDiversity]
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
77 Vector of alpha diversity values by sample.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
78 metadata : Metadata
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
79 The sample metadata.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
80 method : Str % Choices('spearman', 'pearson'), optional
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
81 The correlation test to be applied.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
82 intersect_ids : Bool, optional
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
83 If supplied, IDs that are not found in both the alpha diversity vector
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
84 and metadata will be discarded before calculating the correlation.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
85 Default behavior is to error on any mismatched IDs.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
86
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
87 Returns
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
88 -------
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
89 visualization : Visualization
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
90 ]]></help>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
91 <macros>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
92 <import>qiime_citation.xml</import>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
93 </macros>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
94 <expand macro="qiime_citation"/>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
95 </tool>