Skip to main content

MetaClassifier is an integrated pipeline for classifying and quantifying DNA metabarcoding data into taxonomy groups

Project description

MetaClassifier

Overview

MetaClassifier is an integrated pipeline for identifying the floral composition of honey using DNA metabarcoding to determine the plants that honey bees visit. MetaClassifier utilizes a database of marker sequences and their corresponding taxonomy lineage information to classify high-throughput metabarcoding sample sequencing reads data into taxonomic groups and quantify taxon abundance. MetaClassifier can also be employed in other studies that utilize barcoding, metabarcoding, and metagenomics techniques to characterize richness, abundance, relatedness, and interactions in ecological communities.

In addition to this README file, you can consult the MetaClassifier manual for more detailed information.

Installation

MetaClassifier requires dependencies and external tools that need to be installed and available on the environment the pipeline can be used. Not a requirement if insatalling using Bioconda.

Dependecies

External tools

  • PEAR for merging overlapping paired-end (PE) reads
  • seqtk for converting FASTQ to FASTA sequence format
  • VSEARCH for searching searching high-throughtput sequence read data against marker database

Python package installation

MetaClassifier is available through pypi. To install, type:

pip install metaclassifier

Repository from GitHub

Either "git clone https://github.com/ewafula/MetaClassifier.git" or download and "unzip MetaClassifier-main.zip"
cd MetaClassifier/
python setup.py install

Bioconda package

This requires a working Conda installation.

conda install -c bioconda metaclassifier

We recommend installing MetaClassifier in a new separate environment from the base for all dependencies to be properly resolved by conda. To install, type:

conda create -n "metaclassifier" -c bioconda metaclassifier=1.0.1

Marker reference databases

MetaCurator reference databases with taxonomy lineage information reformated to work with MetaClassifier. Detailed step by step tutorial workflow for creating reference marker database is descrribe on the GitHub MetaCurator database repository

Basic usage

metaclassifier [options] <SAMPLE_FILE> <DB_DIR> <CONFIG_FILE>

Please consult the MetaClassifier manual for a detailed description and usage of all options.

Citation

If you use MetaClassifier please cite the following paper the describes the methodology:

Characterizing the floral resources of a North American metropolis using a honey bee foraging assay.
Douglas B. Sponsler, Don Shump, Rodney T. Richardson, Christina M. Grozinger.
Ecosphere 11, no. 4 (2020): e03102.
DOI: https://doi.org/10.1002/ecs2.3102

License

MetaClassifier is distributed under the GNU GPL v3.0 For more information, see license.

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

metaclassifier-1.0.1.tar.gz (9.9 kB view details)

Uploaded Source

Built Distribution

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

metaclassifier-1.0.1-py3-none-any.whl (24.1 kB view details)

Uploaded Python 3

File details

Details for the file metaclassifier-1.0.1.tar.gz.

File metadata

  • Download URL: metaclassifier-1.0.1.tar.gz
  • Upload date:
  • Size: 9.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.8.5

File hashes

Hashes for metaclassifier-1.0.1.tar.gz
Algorithm Hash digest
SHA256 7b2ee5437bb4e234b83d568d4f671ab83b635370be155df4d3e916cdd5b473ef
MD5 92a898eb6a200f6052e2e3563a4fbc7a
BLAKE2b-256 039b2a30a5f4837237bb6693eb56cb10f42b581e9aaea679d017e27efd1fd1e5

See more details on using hashes here.

File details

Details for the file metaclassifier-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: metaclassifier-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 24.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.8.5

File hashes

Hashes for metaclassifier-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c70d70266d1c97d9e8d0055e3e84456ade999e5ae8d31b27ba8844c631784f01
MD5 d80d36512c295f31b99c45a66090683f
BLAKE2b-256 ef3a8218a09c9d4cbbdb689ca2711e71e7b74a08ab1071709f43843b0473bd3f

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