Skip to main content

🦎 IGUA Stars

Iterative Gene clUster Analysis, a high-throughput method for gene cluster family identification.

Actions Coverage PyPI Bioconda AUR Wheel Python Versions Python Implementations License Source Mirror GitHub issues Docs Changelog Downloads Preprint

🗺️ Overview

IGUA is a method for high-throughput content-agnostic identification of Gene Cluster Families (GCFs) from gene clusters of genomic and metagenomic origin. It performs three clustering iterations to perform GCF assignment:

  • Fragment mapping identification: Reduce the input sequence space by identifying which gene clusters are fragments of each other.
  • Nucleotide deduplication: Find similar gene clusters in genomic space, using linear clustering with lower sequence identity and coverage.
  • Protein representation: Compute a numerical representation of gene clusters in term of protein composition, using representatives from a protein sequence clustering, to identify more distant relatives not captured by the previous step.

Compared to similar methods such as BiG-SLiCE or BiG-SCAPE, IGUA does not use Pfam domains to represent gene cluster composition, using instead representatives from an unsupervised clustering. This allows IGUA to accurately account for proteins that may not be covered by Pfam, and avoids performing a costly annotation step. The resulting protein representatives can be later annotated indepently to transfer annotations to the GCFs.

🔧 Installing

Bioconda

IGUA and all of its dependencies are available via Bioconda and can be installed using e.g., conda or pixi:

  1. First, set up Bioconda with Pixi or Conda.

  2. Then, install IGUA using the appropriate method:

With conda:

$ conda install igua

With pixi:

$ pixi add igua

Apptainer, Docker, and Singularity

IGUA (and all of its dependencies) can be run using e.g., Docker, Apptainer, and Singularity, using images available here.

An example using Apptainer (using IGUA v0.1.0):

apptainer pull docker://quay.io/biocontainers/igua:0.1.0--py39h5b94c0b_0

pip

IGUA can be downloaded directly from PyPI, which hosts pre-compiled distributions for Linux, MacOS and Windows. Simply install with pip:

$ pip install igua

Note that you will need to install MMseqs2 yourself through other means.

💡 Running

📥 Inputs

The gene clusters to pass to IGUA must be in GenBank format, with gene annotations inside of CDS features. Several GenBank files can be passed to the same pipeline run.

$ igua -g clusters1.gbk -g clusters2.gbk ...

The GenBank locus identifier will be used as the name of each gene cluster. This may cause problems with gene clusters obtained with some tools, such as antiSMASH. If the input contains duplicate identifiers, the first gene cluster with a given identifier will be used, and a warning will be displayed.

📤 Outputs

The main output of IGUA is a TSV file which assigns a Gene Cluster Family to each gene cluster found in the input. The GCF identifiers are arbitrary, and the prefix can be changed with the --prefix flag. The table will also record the original file from which each record was obtained to facilitate resource management. The table is written to the filename given with the --output flag.

The sequences of the representative proteins extracted from each cluster can be saved to a FASTA file with the --features flag. These proteins are used for compositional representation of gene clusters, and can be used to transfer annotations to the GCF representatives. The final compositional matrix for each GCF representative, which can be useful for computing distances between GCFs, can be saved as an anndata sparse matrix to a filename given with the --compositions flag.

📝 Workspace

MMseqs needs a fast scratch space to work with intermediate files while running linear clustering. By default, this will use a temporary folder obtained with tempfile.TemporaryDirectory, which typically lies inside /tmp. To use a different folder, use the --workdir flag.

🫧 Clustering

By default, IGUA will use average linkage clustering and a relative distance threshold of 0.8, which corresponds to clusters inside a GCF having at most 20% of estimated difference at the amino-acid level. These two options can be changed with the --clustering-method and --clustering-distance flags.

Additionally, the precision of the distance matrix used for the clustering can be lowered to reduce memory usage, using single or half precision floating point numbers instead of the double precision used by default. Use the --clustering-precision flag to control numerical precision.

💭 Feedback

⚠️ Issue Tracker

Found a bug ? Have an enhancement request ? Head over to the GitHub issue tracker if you need to report or ask something. If you are filing in on a bug, please include as much information as you can about the issue, and try to recreate the same bug in a simple, easily reproducible situation.

🏗️ Contributing

Contributions are more than welcome! See CONTRIBUTING.md for more details.

📋 Changelog

This project adheres to Semantic Versioning and provides a changelog in the Keep a Changelog format.

⚖️ License

This library is provided under the GNU General Public License v3.0.

This project was developed by Martin Larralde during his PhD project at the European Molecular Biology Laboratory and the Leiden University Medical Center in the Zeller team.

Download files

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

Source Distribution

igua-0.2.2.tar.gz (532.3 kB view details)

Uploaded Source

Built Distributions

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

igua-0.2.2-cp38-abi3-win_amd64.whl (288.1 kB view details)

Uploaded CPython 3.8+Windows x86-64

igua-0.2.2-cp38-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (452.6 kB view details)

Uploaded CPython 3.8+manylinux: glibc 2.17+ x86-64

igua-0.2.2-cp38-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (433.1 kB view details)

Uploaded CPython 3.8+manylinux: glibc 2.17+ ARM64

igua-0.2.2-cp38-abi3-macosx_12_0_x86_64.whl (404.2 kB view details)

Uploaded CPython 3.8+macOS 12.0+ x86-64

igua-0.2.2-cp38-abi3-macosx_11_0_arm64.whl (380.3 kB view details)

Uploaded CPython 3.8+macOS 11.0+ ARM64

File details

Details for the file igua-0.2.2.tar.gz.

File metadata

  • Download URL: igua-0.2.2.tar.gz
  • Upload date:
  • Size: 532.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for igua-0.2.2.tar.gz
Algorithm Hash digest
SHA256 302bf9bab8d2308ef17b7962a2d8b5b437a198aefc4055fe94d9a35b3a31205f
MD5 e42dcd4fd0820fdcf298765d3fbceddb
BLAKE2b-256 023006006ed4fdfecaa8fe96537135eaed8e71d63ed7334f3e50084a4fdeee1d

See more details on using hashes here.

Provenance

The following attestation bundles were made for igua-0.2.2.tar.gz:

Publisher: package.yml on zellerlab/IGUA

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file igua-0.2.2-cp38-abi3-win_amd64.whl.

File metadata

  • Download URL: igua-0.2.2-cp38-abi3-win_amd64.whl
  • Upload date:
  • Size: 288.1 kB
  • Tags: CPython 3.8+, Windows x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for igua-0.2.2-cp38-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 ab4db8f0aed70ca4f076843b58816b8435adbe96878338570475bb0014b7e2da
MD5 7811d6ef2dd0628d451d03d00f5cc3a1
BLAKE2b-256 3d83ce7fe4d1b0a36d7f1e136ec92f986a801f0a671ccd6aab770823117590ec

See more details on using hashes here.

Provenance

The following attestation bundles were made for igua-0.2.2-cp38-abi3-win_amd64.whl:

Publisher: package.yml on zellerlab/IGUA

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file igua-0.2.2-cp38-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for igua-0.2.2-cp38-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 c0cb755ac3816d7ba99d7709f31809a1292b052e7464a1090ae41cb8a08e724a
MD5 aa33c7e82e93bda782cfa97b78dadd87
BLAKE2b-256 318b1ff1f60cf670a238a5b1f7333a9559991a5c04138143d0ca4f3f1639006d

See more details on using hashes here.

Provenance

The following attestation bundles were made for igua-0.2.2-cp38-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl:

Publisher: package.yml on zellerlab/IGUA

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file igua-0.2.2-cp38-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl.

File metadata

File hashes

Hashes for igua-0.2.2-cp38-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 77e886f6d3592b68fdc9921ffcbe00ba0ebdd551ea0f7fee6e6ec32ff7cb3fb7
MD5 b7047175aae67242b04a45f4be3010a2
BLAKE2b-256 211c1c05f7b2aefab636085e8da96161a60d6954ce46d4d58a50a0e236527edc

See more details on using hashes here.

Provenance

The following attestation bundles were made for igua-0.2.2-cp38-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl:

Publisher: package.yml on zellerlab/IGUA

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file igua-0.2.2-cp38-abi3-macosx_12_0_x86_64.whl.

File metadata

  • Download URL: igua-0.2.2-cp38-abi3-macosx_12_0_x86_64.whl
  • Upload date:
  • Size: 404.2 kB
  • Tags: CPython 3.8+, macOS 12.0+ x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for igua-0.2.2-cp38-abi3-macosx_12_0_x86_64.whl
Algorithm Hash digest
SHA256 508fde717dbd162971141b9998e91ae4cbadf7cdf0fcbf43aeaefe522d537027
MD5 ef60812e4c3fdd6922a5a1887e5ea08b
BLAKE2b-256 5a836f7cb909593aae4225333df338b3b9f93dc9529be2a615a1d6a610ce5d89

See more details on using hashes here.

Provenance

The following attestation bundles were made for igua-0.2.2-cp38-abi3-macosx_12_0_x86_64.whl:

Publisher: package.yml on zellerlab/IGUA

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file igua-0.2.2-cp38-abi3-macosx_11_0_arm64.whl.

File metadata

  • Download URL: igua-0.2.2-cp38-abi3-macosx_11_0_arm64.whl
  • Upload date:
  • Size: 380.3 kB
  • Tags: CPython 3.8+, macOS 11.0+ ARM64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for igua-0.2.2-cp38-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 c15190f21f48586e2ae2331c60b852ef9cf6b304fa097de2458a4dd300d47c15
MD5 7c0d75945042f9f22bd533f4ae9bc84a
BLAKE2b-256 369ff3035893891f3577f15f12d0c44e54dadca5030d34b1bcff02f026888a8a

See more details on using hashes here.

Provenance

The following attestation bundles were made for igua-0.2.2-cp38-abi3-macosx_11_0_arm64.whl:

Publisher: package.yml on zellerlab/IGUA

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.2.3

6 files

This release

0.2.2 This release

6 files

0.2.1

6 files

0.2.0

6 files

0.1.0.post1

35 files

0.1.0

35 files

0.0.0

1 file

Supported by

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