annotate qiime2-2020.8/qiime_diversity-lib_jaccard.xml @ 22:292c84bd5ab6 draft

Uploaded
author florianbegusch
date Fri, 04 Sep 2020 12:55:05 +0000
parents d93d8888f0b0
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
20
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
1 <?xml version="1.0" ?>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
2 <tool id="qiime_diversity-lib_jaccard" name="qiime diversity-lib jaccard"
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
3 version="2020.8">
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
4 <description>Jaccard Distance</description>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
5 <requirements>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
6 <requirement type="package" version="2020.8">qiime2</requirement>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
7 </requirements>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
8 <command><![CDATA[
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
9 qiime diversity-lib jaccard
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
10
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
11 --i-table=$itable
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
12
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
13 #if str($pnjobs) != 'None':
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
14 --p-n-jobs=$pnjobs
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
15 #end if
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
16
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
17 --o-distance-matrix=odistancematrix
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
18
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
19 #if str($examples) != 'None':
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
20 --examples=$examples
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
21 #end if
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
22
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
23 ;
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
24 cp odistancematrix.qza $odistancematrix
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
25
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
26 ]]></command>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
27 <inputs>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
28 <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" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
29 <param label="--p-n-jobs: " name="pnjobs" optional="True" type="select">
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
30 <option selected="True" value="None">Selection is Optional</option>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
31 <option value="Int % Range(1">Int % Range(1</option>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
32 <option value="None">None</option>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
33 </param>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
34 <param label="--examples: Show usage examples and exit." name="examples" optional="False" type="data" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
35
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
36 </inputs>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
37
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
38 <outputs>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
39 <data format="qza" label="${tool.name} on ${on_string}: distancematrix.qza" name="odistancematrix" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
40
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
41 </outputs>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
42
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
43 <help><![CDATA[
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
44 Jaccard Distance
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
45 ###############################################################
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
46
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
47 Compute Jaccard distance for each sample in a feature table. Jaccard is
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
48 calculated usingpresence/absence data. Data of type FeatureTable[Frequency
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
49 | Relative Frequency] is reducedto presence/absence prior to calculation.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
50
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
51 Parameters
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
52 ----------
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
53 table : FeatureTable[Frequency | RelativeFrequency | PresenceAbsence]
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
54 The feature table containing the samples for which Jaccard distance
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
55 should be computed.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
56 n_jobs : Int % Range(1, None) | Str % Choices('auto'), optional
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
57 The number of concurrent jobs to use in performing this calculation.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
58 May not exceed the number of available physical cores. If n_jobs =
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
59 'auto', one job will be launched for each identified CPU core on the
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
60 host.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
61
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
62 Returns
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
63 -------
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
64 distance_matrix : DistanceMatrix
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
65 Distance matrix for Jaccard index
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
66 ]]></help>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
67 <macros>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
68 <import>qiime_citation.xml</import>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
69 </macros>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
70 <expand macro="qiime_citation"/>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
71 </tool>