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

Uploaded Python 3

File details

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

File metadata

  • Download URL: credtools-0.3.5.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.5.tar.gz
Algorithm Hash digest
SHA256 146784e1a75b144cffdd0ae8f7bf947fb9985826296c39b73f55efa7619e39a7
MD5 6b8dbaf93cf36b8e66bfe4b3c67d8c38
BLAKE2b-256 2c6d4baf561a15b35a498044e5f5beafd9398db7ff4beb7996f7997f2e7454bc

See more details on using hashes here.

File details

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

File metadata

  • Download URL: credtools-0.3.5-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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 803013cc4fc300defe5c3fba964e2f8b55321256eca4b728c4362717a1fbc1e2
MD5 e26ad5753ddfcf518d723e34afb50ea0
BLAKE2b-256 a110b9b151d48b774d1cc2656b103a1a1e43b7c34c1f00a48e2549f350d7c2d3

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