annotate qiime_vsearch_cluster-features-de-novo.xml @ 0:09b7bcb72fa7 draft

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