Skip to main content

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

Metadata

Release files for tiara 1.0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for tiara 1.0.2
File Size Uploaded
tiara-1.0.2.tar.gz 102.4 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for tiara 1.0.2
File Interpreter ABI Platform
tiara-1.0.2-py3-none-any.whl Python 3 none any Details

Total release size: 205.1 MB

Release files / tiara-1.0.2.tar.gz

Download URL tiara-1.0.2.tar.gz
Size 102.4 MB
Tags Source
SHA-256 checksum
How to use checksums
560c87e28daa00b1b783c1c58edf5c54328cea876b670a47c7560f1ee29179bb
BLAKE2b-256 checksum
How to use checksums
2dd3b4c6685c72ef68a1731a66e7f8d75c11f35268d26c5e6d733fc0c90cf33d
Upload date
Uploaded using Trusted Publishing?
What is 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

Release files / tiara-1.0.2-py3-none-any.whl

Download URL tiara-1.0.2-py3-none-any.whl
Size 102.7 MB
Tags Python 3
SHA-256 checksum
How to use checksums
27ee174b6f2a80a56619ead44a0525e5e69852097b75983a1eb89523023fc760
BLAKE2b-256 checksum
How to use checksums
44f6a86c608edd000119299abbdfe63765081ae03c813fca0057cd6dc233e0f9
Upload date
Uploaded using Trusted Publishing?
What is 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

Release history Release notifications | RSS feed

1.0.3

2 release files

This release

1.0.2 This release

2 release files

1.0.1

3 release files

1.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page