annotate qiime2/qiime_diversity_alpha-correlation.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_alpha-correlation" name="qiime diversity alpha-correlation"
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
3 version="2020.8">
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
4 <description>Alpha diversity correlation</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 alpha-correlation
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
10
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
11 --i-alpha-diversity=$ialphadiversity
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 str($pmethod) != 'None':
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
24 --p-method=$pmethod
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
25 #end if
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
26
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
27 #if $pintersectids:
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
28 --p-intersect-ids
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
29 #end if
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
30
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
31 --o-visualization=ovisualization
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
32
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
33 #if str($examples) != 'None':
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
34 --examples=$examples
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
35 #end if
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
36
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
37 ;
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
38 cp oalphadiversity.qza $oalphadiversity
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
39
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
40 ;
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
41 qiime tools export ovisualization.qzv --output-path out
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
42 && mkdir -p '$ovisualization.files_path'
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
43 && cp -r out/* '$ovisualization.files_path'
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
44 && mv '$ovisualization.files_path/index.html' '$ovisualization'
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
45
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
46 ]]></command>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
47 <inputs>
3ba9833030c1 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" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
49 <repeat name="input_files_mmetadatafile" optional="False" title="--m-metadata-file">
3ba9833030c1 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" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
51 </repeat>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
52 <param label="--p-method: " name="pmethod" optional="True" type="select">
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
53 <option selected="True" value="None">Selection is Optional</option>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
54 <option value="spearman">spearman</option>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
55 <option value="pearson">pearson</option>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
56 </param>
3ba9833030c1 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" />
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 Alpha diversity correlation
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
69 ###############################################################
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
70
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
71 Determine whether numeric sample metadata columns are correlated with alpha
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
72 diversity.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
73
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
74 Parameters
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
75 ----------
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
76 alpha_diversity : SampleData[AlphaDiversity]
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
77 Vector of alpha diversity values by sample.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
78 metadata : Metadata
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
79 The sample metadata.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
80 method : Str % Choices('spearman', 'pearson'), optional
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
81 The correlation test to be applied.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
82 intersect_ids : Bool, optional
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
83 If supplied, IDs that are not found in both the alpha diversity vector
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
84 and metadata will be discarded before calculating the correlation.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
85 Default behavior is to error on any mismatched IDs.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
86
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
87 Returns
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
88 -------
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
89 visualization : Visualization
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
90 ]]></help>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
91 <macros>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
92 <import>qiime_citation.xml</import>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
93 </macros>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
94 <expand macro="qiime_citation"/>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
95 </tool>