multi-ancestry fine-mapping pipeline.
Project description
credtools
Multi-ancestry fine-mapping pipeline.
- Documentation: https://Jianhua-Wang.github.io/credtools
- GitHub: https://github.com/Jianhua-Wang/credtools
- PyPI: https://pypi.org/project/credtools/
- Free software: MIT
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.gzfiles
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_refis 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
Release history Release notifications | RSS feed
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.8.0.tar.gz
(3.6 MB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file credtools-0.8.0.tar.gz.
File metadata
- Download URL: credtools-0.8.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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
78e83418a544cd3fd3e6c2ab87b14af2141546c0da7b016dc270e91f3be45cd1
|
|
| MD5 |
e7e6eb43deec14ebea3f747d88c6215d
|
|
| BLAKE2b-256 |
d7e4e0b4d4219f16f98bc5c041c12f2f1d356c917b0d022a9e8cde6e6fc8d4c2
|
File details
Details for the file credtools-0.8.0-py3-none-any.whl.
File metadata
- Download URL: credtools-0.8.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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
98218e7db5764d3938efda2201c844f22f814431101ff0e0b4d5b791649e02e8
|
|
| MD5 |
c8dcadf7a80c0b778e722ebbb1d61bf2
|
|
| BLAKE2b-256 |
ec551d8ca745849207a387cd6cf0d3317962e31e111540a843523a44f51dadb0
|