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 raw_gwas_eur.txt,raw_gwas_asn.txt output/munged/

# Step 2: Identify independent loci and chunk data
credtools chunk output/munged/*.munged.txt.gz output/chunks/

# Step 3: Prepare LD matrices and final inputs
credtools prepare output/chunks/chunk_info.txt genotype_config.json output/prepared/

# Step 4: Run fine-mapping pipeline
credtools pipeline output/prepared/final_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 and create regional chunks for fine-mapping
  • Features:
    • Distance-based independent SNP identification
    • Cross-ancestry loci coordination
    • Configurable significance thresholds
  • Input: Munged summary statistics files
  • Output: Locus-specific chunked files and metadata

Step 3: Prepare Inputs (credtools prepare)

  • Purpose: Generate LD matrices and final fine-mapping input files
  • Features:
    • LD matrix computation from genotype data
    • Variant intersection and quality control
    • Multi-threaded processing
  • Input: Chunked files + genotype data configuration
  • Output: credtools-ready input files (.sumstats.gz, .ld.npz, .ldmap.gz)

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: credtools-0.3.4.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.3.4.tar.gz
Algorithm Hash digest
SHA256 1c5bcaf44543b05798375715eef1a0befa06d270fd2636b5cc51b4cc3ed00212
MD5 7e6401d838e7ce6d28833fea6ff6dc1e
BLAKE2b-256 8fa681c16334f52265e71a48b0c6b2a9c03e56d8b7baa1f7bba9ec1f3a79e5ba

See more details on using hashes here.

File details

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

File metadata

  • Download URL: credtools-0.3.4-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.3.4-py3-none-any.whl
Algorithm Hash digest
SHA256 38634a834eb624fdf3ce123bbf1eb5051b345d4e50479966887986282e8fe0e0
MD5 c902f183c2198d4058c28948b8aa35bd
BLAKE2b-256 5660b34f59f1e3eee8ef827abd826796ad99b2929a5aa8cd1371595cbdbbec90

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