annotate clustering.xml @ 0:fae6527990af draft

Imported from capsule None
author iuc
date Thu, 21 May 2015 03:58:09 -0400
parents
children 8c4e2933a17a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
1 <tool id="vsearch_clustering" name="VSearch clustering" version="@VERSION@.0">
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
2 <description></description>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
3 <macros>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
4 <import>vsearch_macros.xml</import>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
5 </macros>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
6 <expand macro="requirements" />
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
7 <expand macro="stdio" />
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
8 <expand macro="version_command" />
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
9 <command>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
10 <![CDATA[
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
11 vsearch
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
12 @GENERAL@
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
13 --cluster_fast "$infile"
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
14 ##--cluster_smallmem FILENAME cluster sequences using a small amount of memory
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
15 ##--clusters STRING output each cluster to a separate FASTA file
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
16
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
17 #if $maxrejects:
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
18 --maxrejects $maxrejects
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
19 #end if
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
20 #if $maxaccepts:
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
21 --maxaccepts $maxaccepts
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
22 #end if
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
23
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
24 $cons_truncate
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
25 --id $id
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
26 ##--iddef $iddef
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
27
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
28 #if '--msaout' in str($outputs):
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
29 --msaout $msaout
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
30 #end if
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
31 #if '--consout' in str($outputs):
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
32 --consout $consout
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
33 #end if
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
34 #if '--centroids' in str($outputs):
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
35 --centroids $centroids
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
36 #end if
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
37 #if '--alnout' in str($outputs):
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
38 --alnout $alnout
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
39 #end if
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
40 #if '--blast6out' in str($outputs):
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
41 --blast6out $blast6out
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
42 #end if
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
43 #if '--notmatched' in str($outputs):
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
44 --notmatched $notmatched
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
45 #end if
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
46 #if '--fastapairs' in str($outputs):
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
47 --fastapairs $fastapairs
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
48 #end if
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
49 #if '--matched' in str($outputs):
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
50 --matched $matched
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
51 #end if
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
52 #if $qmask != 'no':
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
53 --qmask $qmask
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
54 #end if
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
55 #if $sizein:
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
56 --sizein $sizein
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
57 #end if
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
58 #if $sizeout:
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
59 --sizeout $sizeout
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
60 #end if
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
61 --strand $strand
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
62 --usersort $usersort
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
63
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
64 ]]>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
65 </command>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
66 <inputs>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
67 <param name="infile" type="data" format="fasta" label="Select your FASTA file" help="(--cluster_fast)" />
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
68 <expand macro="id_and_iddef" />
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
69 <param name="cons_truncate" type="boolean" truevalue="--cons_truncate" falsevalue="" checked="False"
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
70 label="Do not ignore terminal gaps in MSA for consensus" help="(--cons_truncate)"/>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
71 <param name="usersort" type="boolean" truevalue="--usersort" falsevalue="" checked="False"
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
72 label="Indicate that input sequences are presorted" help="(--usersort)"/>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
73 <expand macro="qmask" />
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
74 <expand macro="sizein" />
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
75 <expand macro="sizeout" />
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
76 <expand macro="strand" />
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
77 <expand macro="maxrejects" />
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
78 <expand macro="maxaccepts" />
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
79 <expand macro="general_output">
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
80 <option value="--msaout">Multiple sequence alignments</option>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
81 <option value="--consout">Cluster consensus sequences</option>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
82 <option value="--centroids">Centroid sequences</option>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
83 <option value="--notmatched">Write non-matching query sequences to separate file</option>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
84 <option value="--matched">Write matching query sequences to separate file</option>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
85 </expand>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
86
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
87 </inputs>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
88 <outputs>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
89 <data name="msaout" format="fasta" label="${tool.name} on ${on_string}: Multiple Sequence Alignments">
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
90 <filter>'--msaout' in outputs</filter>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
91 </data>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
92 <data name="consout" format="fasta" label="${tool.name} on ${on_string}: Consensus Sequences">
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
93 <filter>'--consout' in outputs</filter>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
94 </data>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
95 <data name="centroids" format="fasta" label="${tool.name} on ${on_string}: Cluster centroids">
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
96 <filter>'--centroids' in outputs</filter>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
97 </data>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
98 <data name="alnout" format="fasta" label="${tool.name} on ${on_string}: Alignment">
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
99 <filter>'--alnout' in outputs</filter>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
100 </data>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
101 <data name="notmatched" format="fasta" label="${tool.name} on ${on_string}: Non-matched queries">
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
102 <filter>'--notmatched' in outputs</filter>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
103 </data>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
104 <data name="matched" format="fasta" label="${tool.name} on ${on_string}: Matching query sequences">
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
105 <filter>'--matched' in outputs</filter>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
106 </data>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
107 <data name="blast6out" format="tabular" label="${tool.name} on ${on_string}: BLAST like tabular">
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
108 <filter>'--blast6out' in outputs</filter>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
109 </data>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
110 <data name="fastapairs" format="fasta" label="${tool.name} on ${on_string}: Query/Target sequences">
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
111 <filter>'--fastapairs' in outputs</filter>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
112 </data>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
113 </outputs>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
114 <tests>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
115 <test>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
116 <param name="infile" value="BioMarKs5k.fsa.bz2" ftype="fasta" />
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
117 <param name="id" value="0.99"/>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
118 <param name="maxaccepts" value="1"/>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
119 <param name="maxrejects" value="2"/>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
120 <param name="sizeout" value="--sizeout"/>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
121 <param name="outputs" value="--centroids,--alnout,--blast6out,--notmatched" />
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
122 <output name="centroids" file="clustering_centroids_result1.fasta" ftype="fasta" />
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
123 <output name="blast6out" file="clustering_blast6out_result1.tab" ftype="tabular" />
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
124 <output name="notmatched" file="clustering_notmatched_result1.fasta" ftype="fasta" />
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
125 <!-- The result following result files would be too big -->
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
126 <!--output name="matched" file="clustering_matched_result1.fasta" ftype="fasta" /-->
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
127 <!--output name="alnout" file="clustering_alnout_result1.fasta" lines_diff="2" ftype="fasta" /-->
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
128 <!--output name="fastapairs" file="clustering_fastapairs_result1.fasta" ftype="fasta" /-->
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
129 <!--output name="msaout" file="clustering_msaout_result1.fasta" ftype="fasta" /-->
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
130 </test>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
131 </tests>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
132 <help>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
133 <![CDATA[
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
134 **What it does**
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
135
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
136 vsearch implements a single-pass, greedy star-clustering algorithm, similar to the algorithms
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
137 implemented in usearch, DNAclust and sumaclust for example.
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
138
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
139
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
140 Clustering options (most searching options also apply)
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
141 --centroids FILENAME output centroid sequences to FASTA file
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
142 --cluster_fast FILENAME cluster sequences fast
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
143 --cluster_smallmem FILENAME cluster sequences using a small amount of memory
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
144 --clusters STRING output each cluster to a separate FASTA file
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
145 --consout FILENAME output cluster consensus sequences to FASTA file
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
146 --cons_truncate do not ignore terminal gaps in MSA for consensus
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
147 --id REAL reject if identity lower
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
148 --iddef INT id definition, 0-4=CD-HIT,all,int,MBL,BLAST (2)
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
149 --msaout FILENAME output multiple seq. alignments to FASTA file
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
150 --qmask mask seqs with dust, soft or no method (dust)
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
151 --sizein read abundance annotation from input
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
152 --sizeout write cluster abundances to centroid file
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
153 --strand cluster using "plus" or "both" strands (plus)
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
154 --usersort indicate that input sequences are presorted
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
155
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
156
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
157 @EXTERNAL_DOCUMENTATION@
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
158
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
159 -------
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
160
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
161 @REFERENCES@
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
162
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
163
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
164 ]]>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
165 </help>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
166 <expand macro="citations" />
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
167 </tool>