annotate qiime2-2020.8/qiime_vsearch_cluster-features-de-novo.xml @ 0:5c352d975ef7 draft

Uploaded
author florianbegusch
date Thu, 03 Sep 2020 09:33:04 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
1 <?xml version="1.0" ?>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
2 <tool id="qiime_vsearch_cluster-features-de-novo" name="qiime vsearch cluster-features-de-novo"
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
3 version="2020.8">
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
4 <description>De novo clustering of features.</description>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
5 <requirements>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
6 <requirement type="package" version="2020.8">qiime2</requirement>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
7 </requirements>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
8 <command><![CDATA[
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
9 qiime vsearch cluster-features-de-novo
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
10
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
11 --i-sequences=$isequences
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
12
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
13 --i-table=$itable
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
14
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
15 --p-perc-identity=$ppercidentity
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
16
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
17 --p-threads=$pthreads
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
18
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
19 --o-clustered-table=oclusteredtable
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
20
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
21 --o-clustered-sequences=oclusteredsequences
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
22
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
23 #if str($examples) != 'None':
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
24 --examples=$examples
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
25 #end if
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
26
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
27 ;
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
28 cp oclusteredsequences.qza $oclusteredsequences
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
29
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
30 ]]></command>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
31 <inputs>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
32 <param format="qza,no_unzip.zip" label="--i-sequences: ARTIFACT FeatureData[Sequence] The sequences corresponding to the features in table. [required]" name="isequences" optional="False" type="data" />
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
33 <param format="qza,no_unzip.zip" label="--i-table: ARTIFACT FeatureTable[Frequency] The feature table to be clustered. [required]" name="itable" optional="False" type="data" />
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
34 <param label="--p-perc-identity: PROPORTION Range(0, 1, inclusive_start=False, inclusive_end=True) The percent identity at which clustering should be performed. This parameter maps to vsearch\'s --id parameter. [required]" name="ppercidentity" optional="False" type="text" />
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
35 <param label="--examples: Show usage examples and exit." name="examples" optional="False" type="data" />
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
36
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
37 </inputs>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
38
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
39 <outputs>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
40 <data format="qza" label="${tool.name} on ${on_string}: clusteredtable.qza" name="oclusteredtable" />
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
41 <data format="qza" label="${tool.name} on ${on_string}: clusteredsequences.qza" name="oclusteredsequences" />
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
42
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
43 </outputs>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
44
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
45 <help><![CDATA[
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
46 De novo clustering of features.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
47 ###############################################################
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
48
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
49 Given a feature table and the associated feature sequences, cluster the
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
50 features based on user-specified percent identity threshold of their
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
51 sequences. This is not a general-purpose de novo clustering method, but
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
52 rather is intended to be used for clustering the results of quality-
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
53 filtering/dereplication methods, such as DADA2, or for re-clustering a
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
54 FeatureTable at a lower percent identity than it was originally clustered
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
55 at. When a group of features in the input table are clustered into a single
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
56 feature, the frequency of that single feature in a given sample is the sum
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
57 of the frequencies of the features that were clustered in that sample.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
58 Feature identifiers and sequences will be inherited from the centroid
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
59 feature of each cluster. See the vsearch documentation for details on how
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
60 sequence clustering is performed.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
61
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
62 Parameters
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
63 ----------
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
64 sequences : FeatureData[Sequence]
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
65 The sequences corresponding to the features in table.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
66 table : FeatureTable[Frequency]
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
67 The feature table to be clustered.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
68 perc_identity : Float % Range(0, 1, inclusive_start=False, inclusive_end=True)
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
69 The percent identity at which clustering should be performed. This
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
70 parameter maps to vsearch's --id parameter.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
71 threads : Int % Range(0, 256, inclusive_end=True), optional
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
72 The number of threads to use for computation. Passing 0 will launch one
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
73 thread per CPU core.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
74
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
75 Returns
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
76 -------
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
77 clustered_table : FeatureTable[Frequency]
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
78 The table following clustering of features.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
79 clustered_sequences : FeatureData[Sequence]
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
80 Sequences representing clustered features.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
81 ]]></help>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
82 <macros>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
83 <import>qiime_citation.xml</import>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
84 </macros>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
85 <expand macro="qiime_citation"/>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
86 </tool>