The aim of this project is to create an alternative to the USEARCH tool developed by Robert C. Edgar (2010). The new tool should:
- have open source code with an appropriate open source license
- be free of charge, gratis
- have a 64-bit design that handles very large databases and much more than 4GB of memory
- be as accurate or more accurate than usearch
- be as fast or faster than usearch
We have implemented a tool called VSEARCH which supports de novo and reference based chimera detection, clustering, full-length and prefix dereplication, rereplication, reverse complementation, masking, all-vs-all pairwise global alignment, exact and global alignment searching, shuffling, subsampling and sorting. It also supports FASTQ file analysis, filtering, conversion and merging of paired-end reads.
VSEARCH stands for vectorized search, as the tool takes advantage of parallelism in the form of SIMD vectorization as well as multiple threads to perform accurate alignments at high speed. VSEARCH uses an optimal global aligner (full dynamic programming Needleman-Wunsch), in contrast to USEARCH which by default uses a heuristic seed and extend aligner. This usually results in more accurate alignments and overall improved sensitivity (recall) with VSEARCH, especially for alignments with gaps.
VSEARCH binaries are provided for GNU/Linux on three processor architectures: x86-64, 64-bit little-endian POWER8 (ppc64le) and 64-bit ARMv8 (aarch64). VSEARCH contains dedicated SIMD code for these three processors architectures (SSE2/SSSE3, AltiVec/VMX/VSX, Neon). Binaries are also provided for MacOS (version 10.9 Mavericks or later) and Windows (64-bit, version 7 or higher).
| CPU \ OS | GNU/Linux | MacOS | Windows |
|---|---|---|---|
| x86_64 | ✔ | ✔ | ✔ |
| ARMv8 | ✔ | ||
| POWER8 | ✔ |
Various packages, plugins and wrappers are also available from other sources - see below.
The source code compiles correctly with gcc (versions 4.8 to 9.1) and llvm-clang (3.8 to 9.0). The source code should also compile on FreeBSD and NetBSD systems.
VSEARCH can directly read input query and database files that are compressed using gzip and bzip2 (.gz and .bz2) if the zlib and bzip2 libraries are available.
Most of the nucleotide based commands and options in USEARCH version 7 are supported, as well as some in version 8. The same option names as in USEARCH version 7 has been used in order to make VSEARCH an almost drop-in replacement. VSEARCH does not support amino acid sequences or local alignments. These features may be added in the future.
If you can't find an answer in the VSEARCH documentation, please visit the VSEARCH Web Forum to post a question or start a discussion.
In the example below, VSEARCH will identify sequences in the file database.fsa that are at least 90% identical on the plus strand to the query sequences in the file queries.fsa and write the results to the file alnout.txt.
./vsearch --usearch_global queries.fsa --db database.fsa --id 0.9 --alnout alnout.txt
Source distribution To download the source distribution from a release and build the executable and the documentation, use the following commands:
wget https://github.com/torognes/vsearch/archive/v2.14.1.tar.gz
tar xzf v2.14.1.tar.gz
cd vsearch-2.14.1
./autogen.sh
./configure
make
make install # as root or sudo make install
You may customize the installation directory using the --prefix=DIR option to configure. If the compression libraries zlib and/or bzip2 are installed on the system, they will be detected automatically and support for compressed files will be included in vsearch. Support for compressed files may be disabled using the --disable-zlib and --disable-bzip2 options to configure. A PDF version of the manual will be created from the vsearch.1 manual file if ps2pdf is available, unless disabled using the --disable-pdfman option to configure. Other options may also be applied to configure, please run configure -h to see them all. GNU autotools (version 2.63 or later) and the gcc compiler is required to build vsearch.
The Windows binary was compiled using the Mingw-w64 C++ cross-compiler.
Cloning the repo Instead of downloading the source distribution as a compressed archive, you could clone the repo and build it as shown below. The options to configure as described above are still valid.
git clone https://github.com/torognes/vsearch.git
cd vsearch
./autogen.sh
./configure
make
make install # as root or sudo make install
Binary distribution Starting with version 1.4.0, binary distribution files containing pre-compiled binaries as well as the documentation will be made available as part of each release. The included executables include support for input files compressed by zlib and bzip2 (with files usually ending in .gz or .bz2).
Binary distributions are provided for x86-64 systems running GNU/Linux, macOS (version 10.7 or higher) and Windows (64-bit, version 7 or higher), as well as POWER8 (ppc64le) and 64-bit AMDv8 (aarch64) systems running GNU/Linux.
Download the appropriate executable for your system using the following commands if you are using a Linux x86_64 system:
wget https://github.com/torognes/vsearch/releases/download/v2.14.1/vsearch-2.14.1-linux-x86_64.tar.gz
tar xzf vsearch-2.14.1-linux-x86_64.tar.gzOr these commands if you are using a Linux ppc64le system:
wget https://github.com/torognes/vsearch/releases/download/v2.14.1/vsearch-2.14.1-linux-ppc64le.tar.gz
tar xzf vsearch-2.14.1-linux-ppc64le.tar.gzOr these commands if you are using a Linux aarch64 system:
wget https://github.com/torognes/vsearch/releases/download/v2.14.1/vsearch-2.14.1-linux-aarch64.tar.gz
tar xzf vsearch-2.14.1-linux-aarch64.tar.gzOr these commands if you are using a Mac:
wget https://github.com/torognes/vsearch/releases/download/v2.14.1/vsearch-2.14.1-macos-x86_64.tar.gz
tar xzf vsearch-2.14.1-macos-x86_64.tar.gzOr if you are using Windows, download and extract (unzip) the contents of this file:
https://github.com/torognes/vsearch/releases/download/v2.14.1/vsearch-2.14.1-win-x86_64.zip
Linux and Mac: You will now have the binary distribution in a folder called vsearch-2.14.1-linux-x86_64 or vsearch-2.14.1-macos-x86_64 in which you will find three subfolders bin, man and doc. We recommend making a copy or a symbolic link to the vsearch binary bin/vsearch in a folder included in your $PATH, and a copy or a symbolic link to the vsearch man page man/vsearch.1 in a folder included in your $MANPATH. The PDF version of the manual is available in doc/vsearch_manual.pdf.
Windows: You will now have the binary distribution in a folder called vsearch-2.14.1-win-x86_64. The vsearch executable is called vsearch.exe. The manual in PDF format is called vsearch_manual.pdf.
Documentation The VSEARCH user's manual is available in the man folder in the form of a man page. A pdf version (vsearch_manual.pdf) will be generated by make. To install the manpage manually, copy the vsearch.1 file or a create a symbolic link to vsearch.1 in a folder included in your $MANPATH. The manual in both formats is also available with the binary distribution. The manual in PDF form (vsearch_manual.pdf) is also attached to the latest release.
Conda package Thanks to the BioConda team, there is now a vsearch package in Conda.
Debian package Thanks to the Debian Med team, there is now a vsearch package in Debian.
FreeBSD ports package Thanks to Jason Bacon, a vsearch FreeBSD ports package is available. Install the binary package with pkg install vsearch, or build from source with additional optimizations.
Galaxy wrapper Thanks to the work of the Intergalactic Utilities Commission members, vsearch is now part of the Galaxy ToolShed.
Homebrew package Thanks to Torsten Seeman, a vsearch package for Homebrew has been made.
Pkgsrc package Thanks to Jason Bacon, a vsearch pkgsrc package is available for NetBSD and other UNIX-like systems. Install the binary package with pkgin install vsearch, or build from source with additional optimizations.
QIIME 2 plugin Thanks to the QIIME 2 team, there is now a plugin called q2-vsearch for QIIME 2.
With the from-uccommand in biom 2.1.5 or later, it is possible to convert data in a .uc file produced by vsearch into a biom file that can be read by QIIME and other software. It is described here.
Please note that vsearch version 2.2.0 and later are able to directly output OTU tables in biom 1.0 format as well as the classic and mothur formats.
Please see the paper for details:
Rognes T, Flouri T, Nichols B, Quince C, Mahé F. (2016) VSEARCH: a versatile open source tool for metagenomics. PeerJ 4:e2584 doi: 10.7717/peerj.2584
When compiling VSEARCH the header files for the following two optional libraries are required if support for gzip and bzip2 compressed FASTA and FASTQ input files is needed:
- libz (zlib library) (zlib.h header file) (optional)
- libbz2 (bzip2lib library) (bzlib.h header file) (optional)
On Windows these libraries are called zlib1.dll and bz2.dll.
VSEARCH will automatically check whether these libraries are available and load them dynamically.
To create the PDF file with the manual the ps2pdf tool is required. It is part of the ghostscript package.
The VSEARCH code is dual-licensed either under the GNU General Public License version 3 or under the BSD 2-clause license. Please see LICENSE.txt for details.
VSEARCH includes code from several other projects. We thank the authors for making their source code available.
VSEARCH includes code from Google's CityHash project by Geoff Pike and Jyrki Alakuijala, providing some excellent hash functions available under a MIT license.
VSEARCH includes code derived from Tatusov and Lipman's DUST program that is in the public domain.
VSEARCH includes public domain code written by Alexander Peslyak for the MD5 message digest algorithm.
VSEARCH includes public domain code written by Steve Reid and others for the SHA1 message digest algorithm.
The VSEARCH distribution includes code from GNU Autoconf which normally is available under the GNU General Public License, but may be distributed with the special autoconf configure script exception.
VSEARCH may include code from the zlib library copyright Jean-loup Gailly and Mark Adler, distributed under the zlib license.
VSEARCH may include code from the bzip2 library copyright Julian R. Seward, distributed under a BSD-style license.
The code is written in C++ but most of it is actually mostly C with some C++ syntax conventions.
| File | Description |
|---|---|
| align.cc | New Needleman-Wunsch global alignment, serial. Only for testing. |
| align_simd.cc | SIMD parallel global alignment of 1 query with 8 database sequences |
| allpairs.cc | All-vs-all optimal global pairwise alignment (no heuristics) |
| arch.cc | Architecture specific code (Mac/Linux) |
| attributes.cc | Extraction and printing of attributes in FASTA headers |
| bitmap.cc | Implementation of bitmaps |
| chimera.cc | Chimera detection |
| city.cc | CityHash code |
| cluster.cc | Clustering (cluster_fast and cluster_smallmem) |
| cpu.cc | Code dependent on specific cpu features (e.g. ssse3) |
| db.cc | Handles the database file read, access etc |
| dbhash.cc | Database hashing for exact searches |
| dbindex.cc | Indexes the database by identifying unique kmers in the sequences |
| derep.cc | Dereplication |
| dynlibs.cc | Dynamic loading of compression libraries |
| eestats.cc | Produce statistics for fastq_eestats command |
| fasta.cc | FASTA file parser |
| fastq.cc | FASTQ file parser |
| fastqjoin.cc | FASTQ paired-end reads joining |
| fastqops.cc | FASTQ file statistics etc |
| fastx.cc | Detection of FASTA and FASTQ files, wrapper for FASTA and FASTQ parsers |
| filter.cc | Trimming and filtering of sequences in FASTA and FASTQ files |
| getseq.cc | Extraction of sequences based on header labels |
| kmerhash.cc | Hash for kmers used by paired-end read merger |
| linmemalign.cc | Linear memory global sequence aligner |
| maps.cc | Various character mapping arrays |
| mask.cc | Masking (DUST) |
| md5.c | MD5 message digest |
| mergepairs.cc | Paired-end read merging |
| minheap.cc | A minheap implementation for the list of top kmer matches |
| msa.cc | Simple multiple sequence alignment and consensus sequence computation for clusters |
| otutable.cc | Generate OTU tables in various formats |
| rerep.cc | Rereplication |
| results.cc | Output results in various formats (alnout, userout, blast6, uc) |
| search.cc | Implements search using global alignment |
| searchcore.cc | Core search functions for searching, clustering and chimera detection |
| searchexact.cc | Exact search functions |
| sffconvert.cc | SFF to FASTQ file conversion |
| sha1.c | SHA1 message digest |
| showalign.cc | Output an alignment in a human-readable way given a CIGAR-string and the sequences |
| shuffle.cc | Shuffle sequences |
| sortbylength.cc | Code for sorting by length |
| sortbysize.cc | Code for sorting by size (abundance) |
| subsample.cc | Subsampling reads from a FASTA file |
| udb.cc | UDB database file handling |
| unique.cc | Find unique kmers in a sequence |
| userfields.cc | Code for parsing the userfields option argument |
| util.cc | Various common utility functions |
| vsearch.cc | Main program file, general initialization, reads arguments and parses options, writes info. |
| xstring.h | Code for a simple string class |
VSEARCH may be compiled with zlib or bzip2 integration that allows it to read compressed FASTA files. The zlib and the bzip2 libraries are needed for this.
All bug reports are highly appreciated. You may submit a bug report here on GitHub as an issue, you could post a message on the VSEARCH Web Forum or you could send an email to [email protected].
VSEARCH is designed for rather short sequences, and will be slow when sequences are longer than about 5,000 bp. This is because it always performs optimal global alignment on selected sequences.
The main contributors to VSEARCH:
- Torbjørn Rognes [email protected] (Coding, testing, documentation, evaluation)
- Frédéric Mahé [email protected] (Documentation, testing, feature suggestions)
- Tomáš Flouri [email protected] (Coding, testing)
- Christopher Quince [email protected] (Initiator, feature suggestions, evaluation)
- Ben Nichols [email protected] (Evaluation)
Special thanks to the following people for patches, suggestions, computer access etc:
- Davide Albanese
- Colin Brislawn
- Jeff Epler
- Christopher M. Sullivan
- Andreas Tille
- Sarah Westcott
Please cite the following publication if you use VSEARCH:
Rognes T, Flouri T, Nichols B, Quince C, Mahé F. (2016) VSEARCH: a versatile open source tool for metagenomics. PeerJ 4:e2584. doi: 10.7717/peerj.2584
Please note that citing any of the underlying algorithms, e.g. UCHIME, may also be appropriate.
Test datasets (found in the separate vsearch-data repository) were obtained from the BioMarks project (Logares et al. 2014), the TARA OCEANS project (Karsenti et al. 2011) and the Protist Ribosomal Database (Guillou et al. 2012).
-
Edgar RC (2010) Search and clustering orders of magnitude faster than BLAST. Bioinformatics, 26 (19): 2460-2461. doi:10.1093/bioinformatics/btq461
-
Edgar RC, Haas BJ, Clemente JC, Quince C, Knight R (2011) UCHIME improves sensitivity and speed of chimera detection. Bioinformatics, 27 (16): 2194-2200. doi:10.1093/bioinformatics/btr381
-
Guillou L, Bachar D, Audic S, Bass D, Berney C, Bittner L, Boutte C, Burgaud G, de Vargas C, Decelle J, del Campo J, Dolan J, Dunthorn M, Edvardsen B, Holzmann M, Kooistra W, Lara E, Lebescot N, Logares R, Mahé F, Massana R, Montresor M, Morard R, Not F, Pawlowski J, Probert I, Sauvadet A-L, Siano R, Stoeck T, Vaulot D, Zimmermann P & Christen R (2013) The Protist Ribosomal Reference database (PR2): a catalog of unicellular eukaryote Small Sub-Unit rRNA sequences with curated taxonomy. Nucleic Acids Research, 41 (D1), D597-D604. doi:10.1093/nar/gks1160
-
Karsenti E, González Acinas S, Bork P, Bowler C, de Vargas C, Raes J, Sullivan M B, Arendt D, Benzoni F, Claverie J-M, Follows M, Jaillon O, Gorsky G, Hingamp P, Iudicone D, Kandels-Lewis S, Krzic U, Not F, Ogata H, Pesant S, Reynaud E G, Sardet C, Sieracki M E, Speich S, Velayoudon D, Weissenbach J, Wincker P & the Tara Oceans Consortium (2011) A holistic approach to marine eco-systems biology. PLoS Biology, 9(10), e1001177. doi:10.1371/journal.pbio.1001177
-
Logares R, Audic S, Bass D, Bittner L, Boutte C, Christen R, Claverie J-M, Decelle J, Dolan J R, Dunthorn M, Edvardsen B, Gobet A, Kooistra W H C F, Mahé F, Not F, Ogata H, Pawlowski J, Pernice M C, Romac S, Shalchian-Tabrizi K, Simon N, Stoeck T, Santini S, Siano R, Wincker P, Zingone A, Richards T, de Vargas C & Massana R (2014) The patterning of rare and abundant community assemblages in coastal marine-planktonic microbial eukaryotes. Current Biology, 24(8), 813-821. doi:10.1016/j.cub.2014.02.050
-
Rognes T (2011) Faster Smith-Waterman database searches by inter-sequence SIMD parallelisation. BMC Bioinformatics, 12: 221. doi:10.1186/1471-2105-12-221