Skip to main content

A tool for classifying metagenomic data

Project description

Tiara

Deep-learning-based approach for identification of eukaryotic sequences in the metagenomic data powered by PyTorch.

The sequences are classified in two stages:

  • In the first stage, the sequences are classified to classes: archaea, bacteria, prokarya, eukarya, organelle and unknown.
  • In the second stage, the sequences labeled as organelle in the first stage are classified to either mitochondria, plastid or unknown.

For more information, please refer to our paper: Tiara: Deep learning-based classification system for eukaryotic sequences.

Requirements

  • Python >= 3.7
  • numpy, biopython, torch, skorch, tqdm, joblib, numba

Installation

More detailed installation instructions can be found here.

Using pip

Run pip install tiara, preferably in a fresh environment.

Using setup.py

Latest stable release
Latest developer version
git clone https://github.com/ibe-uw/tiara.git
cd tiara
python setup.py install

Testing the installation

After the installation, run tiara-test to see if the installation was successful.

Usage

Basic usage:

tiara -i sample_input.fasta -o out.txt

The sequences in the fasta file should be at least 3000 bases long (default value). We do not recommend classify sequences that are shorter than 1000 base pairs.

It creates two files:

  • out.txt, a tab-separated file with header sequence id, first stage classification result, second stage classification result.
  • log_out.txt, containing model parameters and classification summary.

Advanced:

tiara -i sample_input.fasta -o out.txt --tf mit pla pro -t 4 -p 0.65 0.60 --probabilities

In addition to creating the files above, it creates, in the folder where tiara is run, three files containing sequences from sample_input.fasta classified as mitochondria, plastid and prokarya (--tf mit pla pro option).

The number of threads is set to 4 (-t 4) and probability cutoffs in the first and second stage of classification are set to 0.65 and 0.6, respectively.

The probabilities of belonging to individual classes are also written to out.txt, thanks to --probabilities option.

For more usage examples, go here.

Citation

https://doi.org/10.1101/2021.02.08.430199

License

Tiara is released under an open-source MIT 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

tiara-1.0.2.tar.gz (102.4 MB view details)

Uploaded Source

Built Distribution

tiara-1.0.2-py3-none-any.whl (102.7 MB view details)

Uploaded Python 3

File details

Details for the file tiara-1.0.2.tar.gz.

File metadata

  • Download URL: tiara-1.0.2.tar.gz
  • Upload date:
  • Size: 102.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.9.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.9.2

File hashes

Hashes for tiara-1.0.2.tar.gz
Algorithm Hash digest
SHA256 560c87e28daa00b1b783c1c58edf5c54328cea876b670a47c7560f1ee29179bb
MD5 92fdd38747b18234cf9f0972dd0d109b
BLAKE2b-256 2dd3b4c6685c72ef68a1731a66e7f8d75c11f35268d26c5e6d733fc0c90cf33d

See more details on using hashes here.

File details

Details for the file tiara-1.0.2-py3-none-any.whl.

File metadata

  • Download URL: tiara-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 102.7 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.9.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.9.2

File hashes

Hashes for tiara-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 27ee174b6f2a80a56619ead44a0525e5e69852097b75983a1eb89523023fc760
MD5 8c606c07e0e86fb4688dedce781ad054
BLAKE2b-256 44f6a86c608edd000119299abbdfe63765081ae03c813fca0057cd6dc233e0f9

See more details on using hashes here.

Supported by

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