search

myles-lewis / locuszoomr

A pure R implementation of locuszoom for plotting genetic data at genomic loci accompanied by gene annotations.
GNU General Public License v3.0
18 stars 5 forks source link

readme

locuszoomr

CRAN status Downloads

This is a pure R implementation of locuszoom for plotting genetic data at genomic loci accompanied by gene annotations. Plots can be produced in base graphics, ggplot2 or plotly. Plots can be stacked or laid out with multiple plots per page, or the gene track can be plotted separately and added to your own plots.

The LDlink API can be queried to obtain linkage disequilibrium data from 1000 Genomes. Recombination rate can also be shown by querying UCSC genome browser.

See the detailed vignette for code examples.

Installation

Bioconductor package ensembldb and an Ensembl database installed either as a package or accessed through Bioconductor package AnnotationHub are required before installation.

if (!requireNamespace("BiocManager", quietly = TRUE))
  install.packages("BiocManager")
BiocManager::install("ensembldb")
BiocManager::install("EnsDb.Hsapiens.v75")

Install from CRAN

install.packages("locuszoomr")

Install from Github

devtools::install_github("myles-lewis/locuszoomr")

locuszoomr can leverage the LDlinkR package to query the 1000 Genomes Project for linkage disequilibrium (LD) across SNPs. In order to make use of this API function you will need a personal access token, available from the LDlink website.

We recommend that users who want to add recombination rate lines to multiple plots download the recombination rate track from UCSC and use it as described in the 'Add recombination rate' section in the vignette.

Example locus plot

# Locus plot using SLE GWAS data from Bentham et al 2015
# Using subset of data embedded in the package
library(locuszoomr)
data(SLE_gwas_sub)

library(EnsDb.Hsapiens.v75)
loc <- locus(gene = 'UBE2L3', SLE_gwas_sub, flank = 1e5,
             ens_db = "EnsDb.Hsapiens.v75")
summary(loc)
locus_plot(loc)

# Or FTP download the full summary statistics from
# https://www.ebi.ac.uk/gwas/studies/GCST003156
library(data.table)
SLE_gwas <- fread('../bentham_2015_26502338_sle_efo0002690_1_gwas.sumstats.tsv')

loc <- locus(gene = 'UBE2L3', SLE_gwas, flank = 1e5,
             ens_db = "EnsDb.Hsapiens.v75")
locus_plot(loc)