diff qiime2/qiime_diversity-lib_jaccard.xml @ 14:a0a8d77a991c draft

Uploaded
author florianbegusch
date Thu, 03 Sep 2020 09:51:29 +0000
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/qiime2/qiime_diversity-lib_jaccard.xml	Thu Sep 03 09:51:29 2020 +0000
@@ -0,0 +1,71 @@
+<?xml version="1.0" ?>
+<tool id="qiime_diversity-lib_jaccard" name="qiime diversity-lib jaccard"
+      version="2020.8">
+  <description>Jaccard Distance</description>
+  <requirements>
+    <requirement type="package" version="2020.8">qiime2</requirement>
+  </requirements>
+  <command><![CDATA[
+qiime diversity-lib jaccard
+
+--i-table=$itable
+
+#if str($pnjobs) != 'None':
+--p-n-jobs=$pnjobs
+#end if
+
+--o-distance-matrix=odistancematrix
+
+#if str($examples) != 'None':
+--examples=$examples
+#end if
+
+;
+cp odistancematrix.qza $odistancematrix
+
+  ]]></command>
+  <inputs>
+    <param format="qza,no_unzip.zip" label="--i-table: ARTIFACT FeatureTable[Frequency | RelativeFrequency | PresenceAbsence]   The feature table containing the samples for which Jaccard distance should be computed.         [required]" name="itable" optional="False" type="data" />
+    <param label="--p-n-jobs: " name="pnjobs" optional="True" type="select">
+      <option selected="True" value="None">Selection is Optional</option>
+      <option value="Int % Range(1">Int % Range(1</option>
+      <option value="None">None</option>
+    </param>
+    <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}: distancematrix.qza" name="odistancematrix" />
+    
+  </outputs>
+
+  <help><![CDATA[
+Jaccard Distance
+###############################################################
+
+Compute Jaccard distance for each sample in a feature table. Jaccard is
+calculated usingpresence/absence data. Data of type FeatureTable[Frequency
+| Relative Frequency] is reducedto presence/absence prior to calculation.
+
+Parameters
+----------
+table : FeatureTable[Frequency | RelativeFrequency | PresenceAbsence]
+    The feature table containing the samples for which Jaccard distance
+    should be computed.
+n_jobs : Int % Range(1, None) | Str % Choices('auto'), optional
+    The number of concurrent jobs to use in performing this calculation.
+    May not exceed the number of available physical cores. If n_jobs =
+    'auto', one job will be launched for each identified CPU core on the
+    host.
+
+Returns
+-------
+distance_matrix : DistanceMatrix
+    Distance matrix for Jaccard index
+  ]]></help>
+  <macros>
+    <import>qiime_citation.xml</import>
+  </macros>
+  <expand macro="qiime_citation"/>
+</tool>
\ No newline at end of file