Learn R Programming

⚠️There's a newer version (5.2.3) of this package.Take me there.

coloc

version 5

This update (version 5) supercedes previously published version 4 by introducing use of the SuSiE approach to deal with multiple causal variants rather than conditioning or masking. See

Wang, G., Sarkar, A., Carbonetto, P., & Stephens, M. (2020). A simple new approach to variable selection in regression, with application to genetic fine mapping. Journal of the Royal Statistical Society: Series B (Statistical Methodology). https://doi.org/10.1111/rssb.12388

for the full SuSiE paper and

Wallace (2021). A more accurate method for colocalisation analysis allowing for multiple causal variants. bioRxiv https://www.biorxiv.org/content/10.1101/2021.02.23.432421v1

for a description of its use in coloc.

To install from R, do

if(!require("remotes"))
   install.packages("remotes") # if necessary
library(remotes)
install_github("chr1swallace/coloc",build_vignettes=TRUE)

Note that in all simulations, susie outperforms the earlier conditioning approach, so is recommended. However, it is also new code, so please consider the code "beta" and let me know of any issues that arise - they may be a bug on my part. If you want to use it, the function you want to look at is coloc.susie. It can take raw datasets, but the time consuming part is running SuSiE. coloc runs SuSiE and saves a little extra information using the runsusie function before running an adapted colocalisation on the results. So please look at the docs for runsusie too. I found a helpful recipe is

  1. Run runsusie on dataset 1, storing the results
  2. Run runsusie on dataset 2, storing the results
  3. Run coloc.susie on the two outputs from above

More detail is available in the vignette a06_SuSiE.html accessible by

vignette("a06_SuSiE",package="coloc")

Background reading

For usage, please see the vignette at https://chr1swallace.github.io/coloc

Key previous references are:

Frequently Asked Questions

see FAQ

Notes to self

to generate website: https://chr1swallace.github.io/coloc/

Rscript -e "pkgdown::build_site()"

Copy Link

Version

Install

install.packages('coloc')

Monthly Downloads

1,234

Version

5.1.0.1

License

GPL

Issues

Pull Requests

Stars

Forks

Maintainer

Chris Wallace

Last Published

July 5th, 2022

Functions in coloc (5.1.0.1)

check_alignment

check alignment
check_dataset

check_dataset
alpha_to_logbf

alpha_to_logbf
approx.bf.estimates

Internal function, approx.bf.estimates
approx.bf.p

Internal function, approx.bf.p
coloc-package

Colocalisation tests of two genetic traits
coloc.abf

Fully Bayesian colocalisation analysis using Bayes Factors
Var.data.cc

Var.data
coloc.process

Post process a coloc.details result using masking
coloc.bf_bf

Coloc data through Bayes factors
coloc.susie_bf

run coloc using susie to detect separate signals
Var.data

Var.data
bin2lin

binomial to linear regression conversion
est_cond

generate conditional summary stats
coloc.susie

run coloc using susie to detect separate signals
coloc.signals

Coloc with multiple signals per trait
estgeno.1.ctl

estgeno1
logbf_to_pp

logbf 2 pp
finemap.signals

Finemap multiple signals in a single dataset
runsusie

Run susie on a single coloc-structured dataset
logsum

logsum
logdiff

logdiff
sensitivity

Prior sensitivity for coloc
sdY.est

Estimate trait variance, internal function
process.dataset

process.dataset
print.coloc_abf

print.coloc_abf
find.best.signal

Pick out snp with most extreme Z score
finemap.abf

Bayesian finemapping analysis
combine.abf

combine.abf
coloc.detail

Bayesian colocalisation analysis with detailed output
plot.coloc_abf

plot a coloc_abf object
coloc_test_data

Simulated data to use in testing and vignettes in the coloc package
map_cond

find the next most significant SNP, conditioning on a list of sigsnps
map_mask

find the next most significant SNP, masking a list of sigsnps
plot_dataset

plot a coloc dataset