In GMOD/JBrowseR: An R Interface to the JBrowse 2 Genome Browser

knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)

JBrowseR

JBrowseR is an R package that provides a simple and clean interface to JBrowse 2 for R users. Using JBrowseR, you can:

• Embed the JBrowse 2 genome browser in R Markdown documents and Shiny applications
• Deploy a genome browser directly from the R console to view your data
• Customize your genome browser to display your own data

Installation

You can install the released version of JBrowseR from CRAN with:

install.packages("JBrowseR")

And the development version from GitHub with:

# install.packages("devtools")
devtools::install_github("gmod/JBrowseR")

Example

This line of code can be used to launch a genome browser from your R console:

library(JBrowseR)
JBrowseR("ViewHg19", location = "10:29,838,737..29,838,819")

Getting started

In order to get started with JBrowseR, please refer to the vignette that best suits your needs:

• Introduction
• Custom browser tutorial
• JSON configuration tutorial
• Creating URLS

Live demos

Basic usage including text search index

Allows you to search by gene name

https://gmod.shinyapps.io/basic_usage_with_text_index

Multi purpose demo app

Shows a "bookmark" type feature, loading data from data frame, and buttons to navigate to genes of interest

https://gmod.shinyapps.io/bookmarks_demo

Load config.json file

Shows loading a config.json file

https://gmod.shinyapps.io/load_config_json

Load data frame

Simple example showing a data frame as a track

https://gmod.shinyapps.io/load_data_frame

Gene fusion example

Shows putative gene fusions in the SKBR3 breast cancer cell line

https://gmod.shinyapps.io/skbr3_gene_fusions

Citation

If you use JBrowseR in your research, please cite the following publication:

Hershberg et al., 2021. JBrowseR: An R Interface to the JBrowse 2 Genome Browser

@article{hershberg2021jbrowser,
  title={JBrowseR: An R Interface to the JBrowse 2 Genome Browser},
  author={Hershberg, Elliot A and Stevens, Garrett and Diesh, Colin and Xie, Peter and De Jesus Martinez, Teresa and Buels, Robert and Stein, Lincoln and Holmes, Ian},
  journal={Bioinformatics}
}

For developers

To modify the codebase, you can set up a dev environment as follows

git clone https://github.com/GMOD/JBrowseR
cd JBrowseR
yarn
yarn build # build current webpack dependencies
R
install.packages('devtools')
devtools::install()
library(JBrowseR)
JBrowseR("ViewHg19", location = "10:29,838,737..29,838,819")      # this will now use your local build of JBrowseR

GMOD/JBrowseR documentation built on March 16, 2024, 5:37 p.m.