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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for credtools-0.6.0.tar.gz
Algorithm Hash digest
SHA256 6ec56d8c9dddea5f84034e1c4db719a76cfbdf46696ebbe408c2e227ee45c182
MD5 8b95cc8ccd2f00cd428a7185838a2478
BLAKE2b-256 c9898c2f3a25215702d7b7100a94ccf142e7461505a2956977b47266596f96fa

See more details on using hashes here.

File details

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

File metadata

  • Download URL: credtools-0.6.0-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.12

File hashes

Hashes for credtools-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8aa2dfa69a91a2fbd05bf4a00129163fedd95b6e85ab4442489b0484a5fadb08
MD5 58a281acd8049027680baaed5ce13586
BLAKE2b-256 ee18571f5a7d944a4853c4442d231962cf8565ca1e328cde3ca994ab86df1778

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