xtmgah / locusexplorer

An interactive graphical illustration of genetic associations and their biological context

LocusExplorer v0.4

An interactive graphical illustration of genetic associations and their biological context.

Disclaimer

LocusExplorer should be used for illustrative purposes only. Any results provided by LocusExplorer should be used with caution.

Availability

The source code and installation instructions for LocusExplorer are available at https://github.com/oncogenetics/LocusExplorer.

LocusExplorer is made available under the MIT license.

Required Software

LocusExplorer runs in the R environment but is designed to be an easy to use interface that does not require familiarity with R as a prerequisite. LocusExplorer is platform agnostic and able to run on any operating system for which R is available.

LocusExplorer requires R version 3.2.2 to run and can be downloaded by following the instructions at https://www.r-project.org/. Some required packages are not available for earlier versions of R.

After installation of the R software, R packages used by LocusExplorer must be installed prior to use. This may take a few minutes, but is only required on the first occasion. To install packages, open the R program, copy the following code into the R console and hit Return:

#install CRAN packages, if missing
packages <- c("shiny", "shinyjs", "data.table", "dplyr", "tidyr", "ggplot2", "knitr", "markdown", "stringr","DT","seqminer")
if (length(setdiff(packages, rownames(installed.packages()))) > 0) {
  install.packages(setdiff(packages, rownames(installed.packages())), dependencies = TRUE)  
} else { print("All required CRAN packages installed")}

#install Bioconductor packages if missing
source("https://bioconductor.org/biocLite.R")
bioc <- c("ggbio","GenomicRanges","TxDb.Hsapiens.UCSC.hg19.knownGene","org.Hs.eg.db")
if (length(setdiff(bioc, rownames(installed.packages()))) > 0) {
  biocLite(setdiff(bioc, rownames(installed.packages())))  
} else { print("All required Bioconductor packages installed")}

• In cases when user do not have admin rights, pop up window will prompt to set a personal library location for installation of packages, please click yes.
• If using R GUI then user might get prompted to choose CRAN mirror to use for package downloads, please choose the city nearer to your location.
• If prompted to "Update packages all/some/none [a/s/n]", type "n" and hit Return.

Launch LocusExplorer

LocusExplorer runs through a web browser and uses an intuitive interface that does not require high level computational skills to operate.

1. Using runGitHub() within RStudio

Open RStudio (start a new R session) copy the following code into the console and hit Return:

library(shiny)  
runGitHub("LocusExplorer", "oncogenetics", launch.browser = TRUE)

2. Using Download as Zip (Recommended)

Click on Download as ZIP button, this will download the repisotory locally as a zip file LocusExplorer-master.zip. Unzip the folder. Open ui.R file in RStudio (start a new R session) and click on Run App (Please ensure Run External option is selected for full functionality) button at top right corner, or run below code.

library(shiny)  
runApp(launch.browser = TRUE)

Cite LocusExplorer

LocusExplorer: a user-friendly tool for integrated visualisation of genetic association data and biological annotations
Tokhir Dadaev¹, Daniel A Leongamornlert¹, Edward J Saunders¹, Rosalind Eeles^1,2 , Zsofia Kote-Jarai¹

¹Department of Genetics and Epidemiology, The Institute of Cancer Research, London, UK
²Royal Marsden NHS Foundation Trust, London, UK

Bioinformatics first published online November 20, 2015 doi:10.1093/bioinformatics/btv690

Abstract

Summary: In this article we present LocusExplorer, a data visualisation and exploration tool for genetic association data. LocusExplorer is written in R using the Shiny library, providing access to powerful R-based functions through a simple user interface. LocusExplorer allows users to simultaneously display genetic, statistical and biological data for humans in a single image and allows dynamic zooming and customisation of the plot features. Publication quality plots may then be produced in a variety of file formats.
Availability and implementation: LocusExplorer is open source and runs through R and a web browser. It is available at www.oncogenetics.icr.ac.uk/LocusExplorer/ or can be installed locally and the source code accessed from https://github.com/oncogenetics/LocusExplorer.

Publications: LocusExplorer plots

• Multiple novel prostate cancer susceptibility signals identified by fine-mapping of known risk loci among Europeans. Al Olama AA et al.
  • Figure 1

Frequently asked questions

See FAQ.

Contact

Questions, suggestions, and bug reports are welcome and appreciated.

• Submit suggestions and bug-reports
• Send pull request
• Contact email [T Dadaev](mailto: [email protected])

To-do List

https://github.com/oncogenetics/LocusExplorer/issues