Skip to main content

IDEAL-GENOM

Documentation Status PyPI version MIT License Docker

IDEAL-GENOM is a comprehensive Python package for automated, reproducible analysis of human genotype data. Currently it has implemented three pipelines: genomic quality control (QC) for case/control studies; processing VCF files after imputation; and genome-wide association studies (GWAS). It wraps years of research at CGE Tübingen, leveraging PLINK 1.9/2.0, GCTA and bcftools and also providing rich reporting and visualizations.

📌 Check out the ECCB 2026 conference poster presenting IDEAL-GENOM.

Key Features

  • Sample QC: Automated sample-level filtering.
  • Ancestry QC: Detection of outlier ancestry samples tailored for homogenous populations and based on 1KG data.
  • Variant QC: Automated variant-level (SNPs) filtering.
  • VCF Processing: Post-imputation VCF to PLINK filtering, harmonization and conversion to PLINK1.9 binaries.
  • GWAS: Generalized Linear Model (GLM) and Generalized Linear Mixed Model (GLMM) and top-hits finding.
  • Visualization: QC steps are complemented with high quality plots for reporting. Population structure visualization powered by dimensionality reduction algorithms such as Uniform Manifold Approximation and Projection (UMAP) and t-SNE. Moreover, it has a visualization functionalities to report GWAS' summary statistics.
  • Flexible configuration: Modular pipeline steps whose configuration is based on YAML files.
  • CLI, Jupyter, and Docker: Run as a command-line tool, in notebooks, or containerized
  • Reproducible: All steps, parameters, and outputs are logged.

Installation

You can install IDEAL-GENOM using pip:

pip install ideal-genom

Or clone the repository and install locally:

git clone https://github.com/LuisGiraldo86/IDEAL-GENOM.git
cd IDEAL-GENOM
pip install .

For Docker usage:

docker build -t ideal-genom .
docker run -it ideal-genom

Installed Genomic Tools in Docker

The IDEAL-GENOM Docker image comes pre-installed with the following genomic analysis tools:

  • PLINK 1.9: Version 20231211
  • PLINK 2.0: Version 20240105 (AVX2 build)
  • GCTA: Version 1.95.0 (Linux x86_64)
  • BCFtools: Version 1.23

These tools are available in the container's PATH and can be used directly in your pipeline steps or custom scripts. Example usage inside the container:

plink --help
plink2 --help
gcta64 --help
bcftools --help

You can run these commands interactively by starting a shell in the container:

docker run -it ideal-genom /bin/bash

This ensures reproducible and ready-to-use genomic analysis workflows.

Metadata

Release files for ideal-genom 1.3.1

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

Source distribution (sdist)

Source distribution for ideal-genom 1.3.1
File Size Uploaded
ideal_genom-1.3.1.tar.gz 152.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for ideal-genom 1.3.1
File Interpreter ABI Platform
ideal_genom-1.3.1-py3-none-any.whl Python 3 none any Details

Total release size: 326.2 kB

Release files / ideal_genom-1.3.1.tar.gz

Download URL ideal_genom-1.3.1.tar.gz
Size 152.4 kB
Tags Source
SHA-256 checksum
How to use checksums
0ff7d2923b58f71bbcd36c0e1588a0687791cade34b34477fe222bb493bad781
BLAKE2b-256 checksum
How to use checksums
d42a9183c573134b2ab0c7d41effab0ef38d7e36c087e1b5b27699d8cbb5e42f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.3.1 CPython/3.12.3 Linux/6.8.0-138-generic

Release files / ideal_genom-1.3.1-py3-none-any.whl

Download URL ideal_genom-1.3.1-py3-none-any.whl
Size 173.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7d7d2fbfb6689a9491ea22c32d7a925adc5e95a6c61750a1ab3e2d21b69369c5
BLAKE2b-256 checksum
How to use checksums
18be9ab143c5d6bfffd282b12ad5bc2f3e377491fc842bbac99a3d047248c54d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.3.1 CPython/3.12.3 Linux/6.8.0-138-generic

Release history Release notifications | RSS feed

1.3.2

2 release files

This release

1.3.1 This release

2 release files

1.3.0

2 release files

1.2.0

2 release files

1.1.0

2 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