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.

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.2.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 ideal-genom 1.2.0
File Size Uploaded
ideal_genom-1.2.0.tar.gz 148.0 kB Details

Built distribution (wheel)

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

Total release size: 317.2 kB

Release files / ideal_genom-1.2.0.tar.gz

Download URL ideal_genom-1.2.0.tar.gz
Size 148.0 kB
Tags Source
SHA-256 checksum
How to use checksums
b37701129753aa9e57b0d98f6076add62d197df877168b4e46efb4bfecfd2238
BLAKE2b-256 checksum
How to use checksums
75812bb4f8aca3d22b8ce9409b6f8a197b5c9a71b4e7bf563d755c8954c2c2bb
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.2.0-py3-none-any.whl

Download URL ideal_genom-1.2.0-py3-none-any.whl
Size 169.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
2de9f2f6948960555dee2df8b6defdc1fce33e25da9d0572229a99bfbb84186a
BLAKE2b-256 checksum
How to use checksums
35e3919500b5cf77c8b9c4ab127184bd13c137e7426e2a3e57fd1e50d9026b40
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 history Release notifications | RSS feed

1.3.2

2 release files

1.3.1

2 release files

1.3.0

2 release files

This release

1.2.0 This release

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