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.

Requirements

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

Installation

More detailed installation instructions can be found here.

Using setup.py

git clone https://github.com/ibe-uw/tiara.git
cd tiara
python setup.py install

This will install tiara in your Python environment.

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

License

Tiara is released under an open-source MIT license

Metadata

Release files for tiara 1.0.0

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.0
File Size Uploaded
tiara-1.0.0.tar.gz 102.4 MB Details

Built distribution (wheel)

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

Total release size: 205.1 MB

Release files / tiara-1.0.0.tar.gz

Download URL tiara-1.0.0.tar.gz
Size 102.4 MB
Tags Source
SHA-256 checksum
How to use checksums
6df6066e263744d70a2bc2825670e02f7749c3935a49e1f8e9876b98c9d4bc98
BLAKE2b-256 checksum
How to use checksums
66266cea439577415181f7071b87ec8bd8c4f402ec54115c6350a12001856339
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/52.0.0.post20210125 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.8.5

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

Download URL tiara-1.0.0-py3-none-any.whl
Size 102.7 MB
Tags Python 3
SHA-256 checksum
How to use checksums
a29bc8fbc08f77490fb850b4fa93c49c74c6a7c1442fba058ec4fc54479ae361
BLAKE2b-256 checksum
How to use checksums
276d2226458f02568d866c64ed6ce8d4e2a5e6e795292355dc404b8a1cb7cd47
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/52.0.0.post20210125 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.8.5

Release history Release notifications | RSS feed

1.0.3

2 release files

1.0.2

2 release files

1.0.1

3 release files

This release

1.0.0 This release

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