Mercurial > repos > florianbegusch > qiime2_suite_zmf

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

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