Skip to content

Installing MetaSBT databases

Fabio Cumbo edited this page May 1, 2023 · 1 revision

We maintain a series of public pre-built ready-to-use MetaSBT databases that can be easily retrieved with the install module. It allows to list all the available public databases whose metadata are maintained separately in the MetaSBT-DBs repository, in addition to installing them on your system. Databases are nothing else than non-compressed tarballs (files with .tar extension) that contain taxonomically organized bloom filter sketches of genomes which composes the Sequence Bloom Trees of thousands of microbial species.

The install module can be used as follow:

metasbt install --database Viruses \
                --database-version 20230316 \
                --install-in ~/MetaSBT-DBs/

Available options

Option Mandatory Description
--database Select a database among those available under --list-databases
--database-file Path to a local database tarball
--database-url URL to a database tarball
--database-version Select a database version. Must be used in conjunction with --database. Use the most updated one by default
--hub Path to a local or remote table with a list of MetaSBT databases. Use the databases table in the MetaSBT-DBs repository by default
--install-in Install a database in a specific location
--list-databases List all the available MetaSBT databases and exit
--version Print current module version and exit