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.
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.0
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.0.tar.gz | 151.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ideal_genom-1.3.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 323.7 kB
Release files / ideal_genom-1.3.0.tar.gz
| Download URL | ideal_genom-1.3.0.tar.gz |
|---|---|
| Size | 151.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9b6b242b220dd488e61f16205686ca4fa1b3d5c836ddfe96ceeb33f879f66bd7
|
|
BLAKE2b-256 checksum How to use checksums |
5849c35b3f794f184193c94eabf5e7237f0f62db0657d2d3be534af017189e88
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.3.4 CPython/3.12.7 Linux/7.0.0-28-generic
|
Release files / ideal_genom-1.3.0-py3-none-any.whl
| Download URL | ideal_genom-1.3.0-py3-none-any.whl |
|---|---|
| Size | 172.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a5df9cd24cc96323bcfa9bf32966a25585eb50d8d209ed26e5a4b2007c959b4f
|
|
BLAKE2b-256 checksum How to use checksums |
6daa44f90da66413a7fd1ffc1368ff537bd75253030f4d741a3a20fd14ddbdc2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.3.4 CPython/3.12.7 Linux/7.0.0-28-generic
|