annotate qiime2-2020.8/qiime_vsearch_cluster-features-closed-reference.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-closed-reference" name="qiime vsearch cluster-features-closed-reference"
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
3 version="2020.8">
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
4 <description> Closed-reference 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-closed-reference
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 --i-reference-sequences=$ireferencesequences
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
16
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
17 --p-perc-identity=$ppercidentity
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
18
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
19 #if str($pstrand) != 'None':
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
20 --p-strand=$pstrand
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
21 #end if
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
22
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
23 --p-threads=$pthreads
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
24
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
25 --o-clustered-table=oclusteredtable
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
26
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
27 --o-clustered-sequences=oclusteredsequences
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
28
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
29 --o-unmatched-sequences=ounmatchedsequences
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
30
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
31 #if str($examples) != 'None':
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
32 --examples=$examples
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
33 #end if
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
34
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
35 ;
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
36 cp ounmatchedsequences.qza $ounmatchedsequences
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
37
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
38 ]]></command>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
39 <inputs>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
40 <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
41 <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
42 <param format="qza,no_unzip.zip" label="--i-reference-sequences: ARTIFACT FeatureData[Sequence] The sequences to use as cluster centroids. [required]" name="ireferencesequences" optional="False" type="data" />
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
43 <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
44 <param label="--p-strand: " name="pstrand" optional="True" type="select">
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
45 <option selected="True" value="None">Selection is Optional</option>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
46 <option value="plus">plus</option>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
47 <option value="both">both</option>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
48 </param>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
49 <param label="--examples: Show usage examples and exit." name="examples" optional="False" type="data" />
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
50
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
51 </inputs>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
52
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
53 <outputs>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
54 <data format="qza" label="${tool.name} on ${on_string}: clusteredtable.qza" name="oclusteredtable" />
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
55 <data format="qza" label="${tool.name} on ${on_string}: clusteredsequences.qza" name="oclusteredsequences" />
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
56 <data format="qza" label="${tool.name} on ${on_string}: unmatchedsequences.qza" name="ounmatchedsequences" />
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
57
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
58 </outputs>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
59
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
60 <help><![CDATA[
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
61 Closed-reference clustering of features.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
62 ###############################################################
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
63
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
64 Given a feature table and the associated feature sequences, cluster the
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
65 features against a reference database based on user-specified percent
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
66 identity threshold of their sequences. This is not a general-purpose
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
67 closed-reference clustering method, but rather is intended to be used for
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
68 clustering the results of quality-filtering/dereplication methods, such as
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
69 DADA2, or for re-clustering a FeatureTable at a lower percent identity than
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
70 it was originally clustered at. When a group of features in the input table
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
71 are clustered into a single feature, the frequency of that single feature
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
72 in a given sample is the sum of the frequencies of the features that were
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
73 clustered in that sample. Feature identifiers will be inherited from the
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
74 centroid feature of each cluster. See the vsearch documentation for details
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
75 on how sequence clustering is performed.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
76
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
77 Parameters
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
78 ----------
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
79 sequences : FeatureData[Sequence]
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
80 The sequences corresponding to the features in table.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
81 table : FeatureTable[Frequency]
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
82 The feature table to be clustered.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
83 reference_sequences : FeatureData[Sequence]
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
84 The sequences to use as cluster centroids.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
85 perc_identity : Float % Range(0, 1, inclusive_start=False, inclusive_end=True)
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
86 The percent identity at which clustering should be performed. This
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
87 parameter maps to vsearch's --id parameter.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
88 strand : Str % Choices('plus', 'both'), optional
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
89 Search plus (i.e., forward) or both (i.e., forward and reverse
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
90 complement) strands.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
91 threads : Int % Range(0, 256, inclusive_end=True), optional
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
92 The number of threads to use for computation. Passing 0 will launch one
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
93 thread per CPU core.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
94
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
95 Returns
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
96 -------
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
97 clustered_table : FeatureTable[Frequency]
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
98 The table following clustering of features.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
99 clustered_sequences : FeatureData[Sequence]
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
100 The sequences representing clustered features, relabeled by the
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
101 reference IDs.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
102 unmatched_sequences : FeatureData[Sequence]
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
103 The sequences which failed to match any reference sequences. This
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
104 output maps to vsearch's --notmatched parameter.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
105 ]]></help>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
106 <macros>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
107 <import>qiime_citation.xml</import>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
108 </macros>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
109 <expand macro="qiime_citation"/>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
110 </tool>