annotate qiime2/qiime_diversity-lib_bray-curtis.xml @ 14:a0a8d77a991c draft

Uploaded
author florianbegusch
date Thu, 03 Sep 2020 09:51:29 +0000
parents
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_bray-curtis" name="qiime diversity-lib bray-curtis"
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
3 version="2020.8">
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
4 <description>Bray-Curtis Dissimilarity</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 bray-curtis
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 str($pnjobs) != 'None':
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
14 --p-n-jobs=$pnjobs
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
15 #end if
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
16
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
17 --o-distance-matrix=odistancematrix
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 odistancematrix.qza $odistancematrix
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] The feature table containing the samples for which Bray-Curtis dissimilarity should be computed. [required]" name="itable" optional="False" type="data" />
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
29 <param label="--p-n-jobs: " name="pnjobs" optional="True" type="select">
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
30 <option selected="True" value="None">Selection is Optional</option>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
31 <option value="Int % Range(1">Int % Range(1</option>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
32 <option value="None">None</option>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
33 </param>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
34 <param label="--examples: Show usage examples and exit." name="examples" optional="False" type="data" />
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
35
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
36 </inputs>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
37
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
38 <outputs>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
39 <data format="qza" label="${tool.name} on ${on_string}: distancematrix.qza" name="odistancematrix" />
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
40
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
41 </outputs>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
42
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
43 <help><![CDATA[
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
44 Bray-Curtis Dissimilarity
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
45 ###############################################################
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
46
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
47 Compute Bray-Curtis dissimilarity for each sample in a feature table. Note:
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
48 Frequency and relative frequency data produce different results unless
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
49 overall sample sizes are identical. Please consider the impact on your
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
50 results if you use Bray-Curtis with count data that has not been adjusted
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
51 (normalized).
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
52
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
53 Parameters
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
54 ----------
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
55 table : FeatureTable[Frequency]
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
56 The feature table containing the samples for which Bray-Curtis
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
57 dissimilarity should be computed.
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
58 n_jobs : Int % Range(1, None) | Str % Choices('auto'), optional
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
59 The number of concurrent jobs to use in performing this calculation.
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
60 May not exceed the number of available physical cores. If n_jobs =
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
61 'auto', one job will be launched for each identified CPU core on the
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
62 host.
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
63
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
64 Returns
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
65 -------
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
66 distance_matrix : DistanceMatrix
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
67 Distance matrix for Bray-Curtis dissimilarity
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
68 ]]></help>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
69 <macros>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
70 <import>qiime_citation.xml</import>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
71 </macros>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
72 <expand macro="qiime_citation"/>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
73 </tool>