Skip to main content

mbctools: A User-Friendly Metabarcoding and Cross-Platform Pipeline for Analyzing Multiple Amplicon Sequencing Data across a Large Diversity of Organisms

Project description

mbctools

This crossplatform (Linux, OSX, Windows) Python program is a toolkit to make the use of VSEARCH easier and interactive, helping to analyze your Metabarcoding NGS data in best conditions. It features the following MAIN MENU:

1 -> INITIAL ANALYSIS (mandatory): read merging, sample-level dereplication, sequence clustering,
	chimera detection, affiliation of sequences to loci, and sequence re-orientation

2 -> PRIMER REMOVAL AND SELECTION OF MINIMUM SEQUENCE ABUNDANCE LEVELS ACCORDING TO USER-DEFINED THRESHOLDS

3 -> GENERATION OF A UNIQUE SEQUENCE FILE FOR EACH LOCUS (comprising all samples' data)

4 -> EXPORTING ANALYSIS RESULTS INTO metaXplor FORMAT

mbctools reference:

Christian Barnabé†, Guilhem Sempéré†, Vincent Manzanilla, Joel Moo Millan, Antoine Amblard-Rambert and Etienne Waleckx (†Co–first authors). mbctools: A User-Friendly Metabarcoding and Cross-Platform Pipeline for Analyzing Multiple Amplicon Sequencing Data across a Large Diversity of Organisms. bioRxiv doi: https://doi.org/10.1101/2024.02.08.579441

VSEARCH reference:

Rognes T, Flouri T, Nichols B, Quince C, Mahe F (2016). VSEARCH: a versatile open source tool for metagenomics. PeerJ 4:e2584 doi: 10.7717/peerj.2584 https://doi.org/10.7717/peerj.2584

metaXplor reference:

Guilhem Sempéré, Adrien Pétel, Magsen Abbé, Pierre Lefeuvre, Philippe Roumagnac, Frédéric Mahé, Gaël Baurens, Denis Filloux. metaXplor: an interactive viral and microbial metagenomic data manager. GigaScience, Volume 10, Issue 2, February 2021, giab001, https://doi.org/10.1093/gigascience/giab001


Requirements

  • Python v3.7 or higher
  • VSEARCH v2.19.0 or higher must be installed and accessible in the PATH (binaries for all platforms available at https://github.com/torognes/vsearch, along with installation procedure descriptions)
  • Windows users will need to enable Powershell script execution using the Set-ExecutionPolicy command

Procedure for Windows setup

  • Download and install latest Python3 release from https://www.python.org/downloads/ (simplest way is to use the 64-bit installer). Don't forget to tick the "Add python.exe to PATH" checkbox before launching setup

  • Download and unzip latest VSEARCH release from https://github.com/torognes/vsearch/releases

  • Locate the path to the vsearch.exe executable (e.g., C:\Users<UserName>\Downloads\vsearch-2.28.1-win-x86_64) and add it to the PATH environment variable as follows:

    • Press Win + R, type sysdm.cpl, and press Enter
    • In the Advanced system settings tab, click Environment Variables
    • Find the Path environment variable and select it. Click Edit
    • In the Edit System Variable window, add an entry pointing to the location of vsearch.exe (not including the file name, only its full path). Click OK until all windows disappear
  • Open a command prompt and type "pip install mbctools"

You should then be able to launch mbctools directly from the command prompt or Powershell, by typing "mbctools".


Test data

Test data are available at https://doi.org/10.23708/W3TODJ and may be used as a guidance example


Getting started

Once VSEARCH + mbctools are installed and accessible from the PATH, and .txt files pointing to the data have been edited, entering the "mbctools" command from a console is normally enough to launch the program. If you did not use pip to install mbctools and directly downloaded mbctools.py from the source code repository, may have have to try different commands like "./mbctools.py", "python mbctools.py" or "python3 mbctools.py"

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mbctools-1.1.1.tar.gz (28.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mbctools-1.1.1-py3-none-any.whl (29.4 kB view details)

Uploaded Python 3

File details

Details for the file mbctools-1.1.1.tar.gz.

File metadata

  • Download URL: mbctools-1.1.1.tar.gz
  • Upload date:
  • Size: 28.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for mbctools-1.1.1.tar.gz
Algorithm Hash digest
SHA256 2380f0dabcc6c0ad60271abcae6e5de62fdc7b075bea4d70114e53e4d059946c
MD5 0cfbe5365ad2c602feb992957983f86a
BLAKE2b-256 58c737067bdd3db34675682802fd2e52453d659a241e41cfa7e43ccc5160c731

See more details on using hashes here.

File details

Details for the file mbctools-1.1.1-py3-none-any.whl.

File metadata

  • Download URL: mbctools-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 29.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for mbctools-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e640920200b07bdf659d673ad0aa017f68a50541f501f2d4cce6ff39dc6e5b4b
MD5 d4ba3e9fc441d376ee7c4c49335b7d61
BLAKE2b-256 73227315efefe44041cdbad1bbdc55dad858dc2f877005d5a16907d435ad7440

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page