Skip to main content

multi-ancestry fine-mapping pipeline.

Project description

credtools

pypi python Build Status codecov License: MIT

Multi-ancestry fine-mapping pipeline.

Features

  • Whole-genome preprocessing: Start from raw GWAS summary statistics and genotype data
    • Standardize and munge summary statistics from various formats
    • Prepare LD matrices and fine-mapping inputs automatically
  • Multi-ancestry fine-mapping: Support for multiple fine-mapping tools (SuSiE, FINEMAP, etc.)
  • Meta-analysis capabilities: Combine results across populations and cohorts
  • Quality control: Built-in QC metrics and visualizations
  • Command-line interface: Easy-to-use CLI for all operations

Installation

Basic Installation

pip install credtools

Install with uv

uv pip install credtools

Quick Start

Command Line Usage

# Complete workflow: from whole-genome data to fine-mapping results
# Step 1: Standardize summary statistics
credtools munge population_config.txt output/munged/

# Step 2: Identify loci, chunk data, and extract LD matrices
credtools chunk output/munged/sumstat_info_updated.txt output/chunks/

# Step 3: Run fine-mapping pipeline
credtools pipeline output/chunks/loci_list.txt output/results/

Preprocessing Workflow

credtools now supports starting from whole-genome summary statistics and genotype data, eliminating the need for manual preprocessing:

Step 1: Munge Summary Statistics (credtools munge)

  • Purpose: Standardize and clean GWAS summary statistics from various formats
  • Features:
    • Automatic header detection and mapping
    • Data validation and quality control
    • Support for multiple file formats
  • Input: Raw GWAS files with various column headers
  • Output: Standardized .munged.txt.gz files

Step 2: Chunk Loci (credtools chunk)

  • Purpose: Identify independent loci, create regional chunks, and extract LD matrices
  • Features:
    • Distance-based independent SNP identification
    • Cross-ancestry loci coordination
    • Configurable significance thresholds
    • Automatic LD matrix extraction when ld_ref is provided in population config
  • Input: Munged summary statistics files (or population config with ld_ref)
  • Output: Locus-specific chunked files, LD matrices, and credtools-ready input files

Multi-Ancestry Support

  • Consistent loci definition: Union approach across ancestries
  • Flexible input formats: Support for various GWAS summary statistics formats
  • Coordinated processing: Ensure compatibility across populations

Documentation

For detailed documentation, see https://Jianhua-Wang.github.io/credtools

Project details


Download files

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

Source Distribution

credtools-0.4.1.tar.gz (3.6 MB view details)

Uploaded Source

Built Distribution

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

credtools-0.4.1-py3-none-any.whl (3.4 MB view details)

Uploaded Python 3

File details

Details for the file credtools-0.4.1.tar.gz.

File metadata

  • Download URL: credtools-0.4.1.tar.gz
  • Upload date:
  • Size: 3.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for credtools-0.4.1.tar.gz
Algorithm Hash digest
SHA256 4b532bde31e4751bdd9a6981f9fe669a789fe83c790fbbc6bc53476122d4fa2e
MD5 2d8922d5a8ff31c5dd5586fb6a1f6539
BLAKE2b-256 97cae10714edb35f30c3de11ee4efc074a9d0420489abd1ac1458b0a79d4edfd

See more details on using hashes here.

File details

Details for the file credtools-0.4.1-py3-none-any.whl.

File metadata

  • Download URL: credtools-0.4.1-py3-none-any.whl
  • Upload date:
  • Size: 3.4 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for credtools-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2288dfe40de1c4a72678a5791605696da783ad12c297ba0aca5b877d14c9dd8c
MD5 86f918005f268c744fb13d5421dac9cd
BLAKE2b-256 498c536f4cbabbeeb675e8c60181b95fab86f930abf58b7fcdf75bac18a64032

See more details on using hashes here.

Supported by

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