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.8.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.8-py3-none-any.whl (3.4 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: credtools-0.4.8.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.8.tar.gz
Algorithm Hash digest
SHA256 621d76e0c9c547d144a7c294e9c4d82678d20a09fce345d053f03b099c9158c3
MD5 3e9db32e25949ab17cd99853bd8b75cb
BLAKE2b-256 3e184d9621ca5e7482968b3eddab4bd186f6ba7ae25d8566ad9b8a0ec42604b6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: credtools-0.4.8-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.8-py3-none-any.whl
Algorithm Hash digest
SHA256 eb3b17072365f2577a84cb804c295af5e74a654a92f809672bec595b5ee2909e
MD5 5bee7f5e18b15e20f2a0b890046a9ba8
BLAKE2b-256 5155dc08e25578b56de960ef1c1a4f72d981f904073c7f15875480aff41dc886

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