annotate qiime2-2020.8/qiime_diversity-lib_shannon-entropy.xml @ 0:5c352d975ef7 draft

Uploaded
author florianbegusch
date Thu, 03 Sep 2020 09:33:04 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
1 <?xml version="1.0" ?>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
2 <tool id="qiime_diversity-lib_shannon-entropy" name="qiime diversity-lib shannon-entropy"
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
3 version="2020.8">
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
4 <description>Shannon\'s Entropy</description>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
5 <requirements>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
6 <requirement type="package" version="2020.8">qiime2</requirement>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
7 </requirements>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
8 <command><![CDATA[
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
9 qiime diversity-lib shannon-entropy
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
10
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
11 --i-table=$itable
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
12
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
13 #if $pdropundefinedsamples:
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
14 --p-drop-undefined-samples
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
15 #end if
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
16
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
17 --o-vector=ovector
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
18
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
19 #if str($examples) != 'None':
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
20 --examples=$examples
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
21 #end if
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
22
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
23 ;
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
24 cp ovector.qza $ovector
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
25
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
26 ]]></command>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
27 <inputs>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
28 <param format="qza,no_unzip.zip" label="--i-table: ARTIFACT FeatureTable[Frequency | RelativeFrequency] The feature table containing the samples for which Shannon\'s Entropy should be computed. [required]" name="itable" optional="False" type="data" />
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
29 <param label="--p-drop-undefined-samples: --p-drop-undefined-samples: / --p-no-drop-undefined-samples Samples with no observed features produce undefined (NaN) values. If true, these samples are dropped from the output vector. [default: False]" name="pdropundefinedsamples" selected="False" type="boolean" />
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
30 <param label="--examples: Show usage examples and exit." name="examples" optional="False" type="data" />
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
31
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
32 </inputs>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
33
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
34 <outputs>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
35 <data format="qza" label="${tool.name} on ${on_string}: vector.qza" name="ovector" />
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
36
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
37 </outputs>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
38
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
39 <help><![CDATA[
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
40 Shannon\'s Entropy
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
41 ###############################################################
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
42
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
43 Compute Shannon's Entropy for each sample in a feature table
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
44
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
45 Parameters
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
46 ----------
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
47 table : FeatureTable[Frequency | RelativeFrequency]
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
48 The feature table containing the samples for which Shannon's Entropy
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
49 should be computed.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
50 drop_undefined_samples : Bool, optional
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
51 Samples with no observed features produce undefined (NaN) values. If
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
52 true, these samples are dropped from the output vector.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
53
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
54 Returns
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
55 -------
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
56 vector : SampleData[AlphaDiversity]
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
57 Vector containing per-sample values for Shannon's Entropy.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
58 ]]></help>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
59 <macros>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
60 <import>qiime_citation.xml</import>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
61 </macros>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
62 <expand macro="qiime_citation"/>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
63 </tool>