annotate qiime_vsearch_cluster-features-open-reference.xml @ 1:f2028d8efed6 draft default tip

Add tool_data_table_conf.xml.sample
author florianbegusch
date Thu, 24 May 2018 03:40:50 -0400
parents 09b7bcb72fa7
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-open-reference" name="qiime vsearch cluster-features-open-reference" version="2018.4">
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Open-reference 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-open-reference --p-perc-identity="$ppercidentity" --i-table=$itable --i-sequences=$isequences --i-reference-sequences=$ireferencesequences
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
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
15 #if str($pstrand) != 'None':
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
16 --p-strand=$pstrand
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
17 #end if
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
18 --o-clustered-sequences=oclusteredsequences --o-new-reference-sequences=onewreferencesequences
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
19 #set $pthreads = '${GALAXY_SLOTS:-4}'
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
20
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
21 #if str($pthreads):
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
22 --p-threads="$pthreads"
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
23 #end if
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
24
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
25 ;
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
26 cp oclusteredtable.qza $oclusteredtable;
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
27 cp oclusteredsequences.qza $oclusteredsequences;
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
28 cp onewreferencesequences.qza $onewreferencesequences
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
29 ]]>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
30 </command>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
31 <inputs>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
32 <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
33 <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
34 <param format="qza,no_unzip.zip" label="--i-reference-sequences: FeatureData[Sequence] The sequences to use as cluster centroids. [required]" name="ireferencesequences" optional="False" type="data"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
35
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
36 <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
37
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
38 <param label="--p-strand: Search plus (i.e., forward) or both (i.e.,
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
39 forward and reverse complement) strands.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
40 [default: plus]" name="pstrand" optional="True" type="select">
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
41 <option selected="True" value="None">Selection is Optional</option>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
42 <option value="both">both</option>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
43 <option value="plus">plus</option>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
44 </param>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
45
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
46 <param label="--cmd-config: Use config file for command options" name="cmdconfig" optional="True" type="data"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
47 </inputs>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
48 <outputs>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
49 <data format="qza" label="${tool.name} on ${on_string}: clustered-table.qza" name="oclusteredtable"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
50 <data format="qza" label="${tool.name} on ${on_string}: clustered-sequences.qza" name="oclusteredsequences"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
51 <data format="qza" label="${tool.name} on ${on_string}: new-reference-sequences.qza" name="onewreferencesequences"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
52 </outputs>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
53 <help>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
54 <![CDATA[
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
55 Open-reference clustering of features.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
56 ---------------------------------------
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
57
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
58 Given a feature table and the associated feature sequences, cluster the
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
59 features against a reference database based on user-specified percent
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
60 identity threshold of their sequences. Any sequences that don't match are
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
61 then clustered de novo. This is not a general-purpose clustering method,
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
62 but rather is intended to be used for clustering the results of quality-
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
63 filtering/dereplication methods, such as DADA2, or for re-clustering a
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
64 FeatureTable at a lower percent identity than it was originally clustered
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
65 at. When a group of features in the input table are clustered into a single
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
66 feature, the frequency of that single feature in a given sample is the sum
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
67 of the frequencies of the features that were clustered in that sample.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
68 Feature identifiers will be inherited from the centroid feature of each
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
69 cluster. For features that match a reference sequence, the centroid feature
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
70 is that reference sequence, so its identifier will become the feature
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
71 identifier. The clustered_sequences result will contain feature
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
72 representative sequences that are derived from the sequences input for all
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
73 features in clustered_table. This will always be the most abundant sequence
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
74 in the cluster. The new_reference_sequences result will contain the entire
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
75 reference database, plus feature representative sequences for any de novo
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
76 features. This is intended to be used as a reference database in subsequent
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
77 iterations of cluster_features_open_reference, if applicable. See the
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
78 vsearch documentation for details on how sequence clustering is performed.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
79
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
80 Parameters
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
81 ----------
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
82 sequences : FeatureData[Sequence]
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
83 The sequences corresponding to the features in table.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
84 table : FeatureTable[Frequency]
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
85 The feature table to be clustered.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
86 reference_sequences : FeatureData[Sequence]
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
87 The sequences to use as cluster centroids.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
88 perc_identity : Float % Range(0, 1, inclusive_start=False, inclusive_end=True)
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
89 The percent identity at which clustering should be performed. This
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
90 parameter maps to vsearch's --id parameter.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
91 strand : Str % Choices({'both', 'plus'}), optional
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
92 Search plus (i.e., forward) or both (i.e., forward and reverse
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
93 complement) strands.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
94
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
95 Returns
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
96 -------
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
97 clustered_table : FeatureTable[Frequency]
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
98 The table following clustering of features.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
99 clustered_sequences : FeatureData[Sequence]
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
100 Sequences representing clustered features.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
101 new_reference_sequences : FeatureData[Sequence]
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
102 The new reference sequences. This can be used for subsequent runs of
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
103 open-reference clustering for consistent definitions of features across
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
104 open-reference feature tables.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
105 ]]>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
106 </help>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
107 </tool>