annotate qiime2/qiime_diversity_alpha-correlation.xml @ 15:276ec629f09a draft

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