Skip to main content

Ultra-fast GPU-enabled Bayesian colocalisation

Project description

gpu-coloc

gpu-coloc is a GPU-accelerated Bayesian colocalization implementation (COLOC), delivering identical results to R's coloc.bf_bf approximately 1000 times faster.

If you have any questions or problems with gpu-coloc, please write to mihkel.jesse@gmail.com.

Citation

If you use gpu-coloc, please cite: (citation placeholder)

Installation

Install via pip (Python ≥3.12):

pip install gpu-coloc

If pip cannot find the package, it is probably do to an older version of pip. Thus to upgrade it run:

pip install --upgrade pip

You can set up gpu-coloc up in a virtual environment:

python -m venv [path_to_venv]
source [path_to_venv]/bin/activate
pip install gpu-coloc

This is prefered in production environments or if you are having trouble with package management.

Verify Installation

To confirm installation, clone this repository:

git clone https://github.com/mjesse-github/gpu-coloc
cd gpu-coloc
bash test.sh

This creates an example/ directory containing an example_results.tsv file.

Workflow

Note: Paths assume gpu-coloc is in the working directory; adjust paths if necessary.

Variant Naming Convention

Variants must follow the naming format: chr[chromosome]_[position]_[ref]_[alt]. Ensure renaming is completed before Step 1. Use chromosome X, not 23.

1. Prepare Signals and Summary Files

  • Signal Files: Save signals as [signal].pickle, containing variants and their log Bayes Factors (lbf).

Example format:

variant	chrX_153412224_C_A	chrX_153412528_C_T	...
lbf	-0.060991	-1.508802	...
  • Summary File: Tab-separated, structured as:
signal	chromosome	location_min	location_max	signal_strength	lead_variant
QTD000141_ENSG00000013563_L1	X	153412224	155341332	12.1069377174147	chrX_154403855_T_G
...

Naming examples:

  • Summary: gwas_summary.tsv
  • Signals directory: gwas_signals/[signal].pickle

See scripts in summary_and_signals_examples/ for reference; modifications may be necessary.

2. Format Data

gpu-coloc --format --input [path_to_signals] --input_summary [summary_file] --output [output_folder]

Parameters for gpu-coloc --format

  • --input (required): Path to the directory containing signal files (e.g., gwas_signals/). Supports pickle or feather files (see --input_type).
  • --output (required): Path to the output directory where formatted parquet files will be saved.
  • --input_summary (required): Path to the summary TSV file (e.g., gwas_summary.tsv).
  • --output_summary (optional): Path to write the formatted summary as a parquet file.
  • --input_type (optional): Type of input files, either 'pickle' (default) or 'feather'.

3. Run Colocalization

gpu-coloc coloc.py --run --dir1 [formatted_dataset_1] --dir2 [formatted_dataset_2] --results [results_output] --p12 1e-6 --H4 0.8

Parameters for gpu-coloc coloc.py --run

  • --dir1 (required): Path to the first formatted dataset directory.
  • --dir2 (required): Path to the second formatted dataset directory.
  • --results (required): Path to the output file where colocalization results will be saved.
  • --p12 (optional): Prior probability that a variant is associated with both traits. Default: 1e-6.
  • --H4 (optional): Posterior probability threshold for declaring colocalization (H4). Default: 0.8.

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

gpu_coloc-0.2.tar.gz (9.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gpu_coloc-0.2-py3-none-any.whl (8.9 kB view details)

Uploaded Python 3

File details

Details for the file gpu_coloc-0.2.tar.gz.

File metadata

  • Download URL: gpu_coloc-0.2.tar.gz
  • Upload date:
  • Size: 9.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for gpu_coloc-0.2.tar.gz
Algorithm Hash digest
SHA256 cfc393d1ead43dab14bfbbd4337f69dd7293755aabf9805c3377ab123abeb89d
MD5 94f2df794ab636eecfca22fb556aa0ad
BLAKE2b-256 5f7f682985534e08ec00d7b45a2b54d9cfeaf62124f26212f5dd542d28b55ca4

See more details on using hashes here.

File details

Details for the file gpu_coloc-0.2-py3-none-any.whl.

File metadata

  • Download URL: gpu_coloc-0.2-py3-none-any.whl
  • Upload date:
  • Size: 8.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for gpu_coloc-0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a6a35a832e287263de9292b2ba0eee728dae196e462484f0a87051ddae903ab5
MD5 c2d8c444d6efcc97354dc96c913b4932
BLAKE2b-256 24c6ca7c00ab18983d43b52b70df72dba09e9ce30b8b7bb0ca1855803237435e

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