diff 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
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/qiime2-2020.8/qiime_diversity-lib_shannon-entropy.xml	Thu Sep 03 09:33:04 2020 +0000
@@ -0,0 +1,63 @@
+<?xml version="1.0" ?>
+<tool id="qiime_diversity-lib_shannon-entropy" name="qiime diversity-lib shannon-entropy"
+      version="2020.8">
+  <description>Shannon\'s Entropy</description>
+  <requirements>
+    <requirement type="package" version="2020.8">qiime2</requirement>
+  </requirements>
+  <command><![CDATA[
+qiime diversity-lib shannon-entropy
+
+--i-table=$itable
+
+#if $pdropundefinedsamples:
+ --p-drop-undefined-samples
+#end if
+
+--o-vector=ovector
+
+#if str($examples) != 'None':
+--examples=$examples
+#end if
+
+;
+cp ovector.qza $ovector
+
+  ]]></command>
+  <inputs>
+    <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" />
+    <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" />
+    <param label="--examples: Show usage examples and exit." name="examples" optional="False" type="data" />
+    
+  </inputs>
+
+  <outputs>
+    <data format="qza" label="${tool.name} on ${on_string}: vector.qza" name="ovector" />
+    
+  </outputs>
+
+  <help><![CDATA[
+Shannon\'s Entropy
+###############################################################
+
+Compute Shannon's Entropy for each sample in a feature table
+
+Parameters
+----------
+table : FeatureTable[Frequency | RelativeFrequency]
+    The feature table containing the samples for which Shannon's Entropy
+    should be computed.
+drop_undefined_samples : Bool, optional
+    Samples with no observed features produce undefined (NaN) values. If
+    true, these samples are dropped from the output vector.
+
+Returns
+-------
+vector : SampleData[AlphaDiversity]
+    Vector containing per-sample values for Shannon's Entropy.
+  ]]></help>
+  <macros>
+    <import>qiime_citation.xml</import>
+  </macros>
+  <expand macro="qiime_citation"/>
+</tool>
\ No newline at end of file