IDEAL-GENOM
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.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ideal_genom-1.3.2.tar.gz | 154.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ideal_genom-1.3.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 328.0 kB
Release files / ideal_genom-1.3.2.tar.gz
| Download URL | ideal_genom-1.3.2.tar.gz |
|---|---|
| Size | 154.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f2ba631529cb7b530cffa46efdf56c75da16182596bf554f92ec60d0e5ce60c0
|
|
BLAKE2b-256 checksum How to use checksums |
5af787c1832dea1d1b6949cd25f0419a702d2bd03b9a8910a7ce610275a55bed
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 2, 2026.
Transparency logRelease files / ideal_genom-1.3.2-py3-none-any.whl
| Download URL | ideal_genom-1.3.2-py3-none-any.whl |
|---|---|
| Size | 173.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ecadc665124972abe36ed143fc8c9e2eeec4cc4b093d9759de174bc1f719f1ee
|
|
BLAKE2b-256 checksum How to use checksums |
ff2006b56f8c701be1e48bd214b5de6ed708dc654c7509bd97dd6febe20cfeb4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 2, 2026.
Transparency log