annotate qiime2/qiime_diversity-lib_pielou-evenness.xml @ 29:3ba9833030c1 draft

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