MyNixOS website logo
Description

An R Interface to the JBrowse 2 Genome Browser.

Provides an R interface to the JBrowse 2 genome browser. Enables embedding a JB2 genome browser in a Shiny app or R Markdown document. The browser can also be launched from an interactive R console. The browser can be loaded with a variety of common genomics data types, and can be used with a custom theme.

JBrowseR

R-CMD-check CRAN status

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:

Live demos

Basic usage including text search index

Allows you to search by gene name

  • Link demo: https://gmod.shinyapps.io/basic_usage_with_text_index
  • Source code: https://github.com/GMOD/JBrowseR/blob/main/example_apps/basic_usage_with_text_index/app.R

Multi purpose demo app

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

  • Live link: https://gmod.shinyapps.io/bookmarks_demo
  • Source code: https://github.com/GMOD/JBrowseR/blob/main/example_apps/bookmarks_demo/app.R

Load config.json file

Shows loading a config.json file

  • Live link: https://gmod.shinyapps.io/load_config_json
  • Source code: https://github.com/GMOD/JBrowseR/blob/main/example_apps/load_config_json/app.R

Load data frame

Simple example showing a data frame as a track

  • Live link: https://gmod.shinyapps.io/load_data_frame
  • Source code: https://github.com/GMOD/JBrowseR/blob/main/example_apps/load_data_frame/app.R

Gene fusion example

Shows putative gene fusions in the SKBR3 breast cancer cell line

  • Live link: https://gmod.shinyapps.io/skbr3_gene_fusions
  • Source code: https://github.com/GMOD/JBrowseR/blob/main/example_apps/skbr3_gene_fusions/app.R

Using plugins

Uses the config.json loading method

  • Live link: not yet online
  • Source code: https://github.com/GMOD/JBrowseR/blob/main/example_apps/using_plugins/app.R

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}
}
Metadata

Version

0.10.2

License

Unknown

Platforms (75)

    Darwin
    FreeBSD
    Genode
    GHCJS
    Linux
    MMIXware
    NetBSD
    none
    OpenBSD
    Redox
    Solaris
    WASI
    Windows
Show all
  • aarch64-darwin
  • aarch64-genode
  • aarch64-linux
  • aarch64-netbsd
  • aarch64-none
  • aarch64_be-none
  • arm-none
  • armv5tel-linux
  • armv6l-linux
  • armv6l-netbsd
  • armv6l-none
  • armv7a-darwin
  • armv7a-linux
  • armv7a-netbsd
  • armv7l-linux
  • armv7l-netbsd
  • avr-none
  • i686-cygwin
  • i686-darwin
  • i686-freebsd
  • i686-genode
  • i686-linux
  • i686-netbsd
  • i686-none
  • i686-openbsd
  • i686-windows
  • javascript-ghcjs
  • loongarch64-linux
  • m68k-linux
  • m68k-netbsd
  • m68k-none
  • microblaze-linux
  • microblaze-none
  • microblazeel-linux
  • microblazeel-none
  • mips-linux
  • mips-none
  • mips64-linux
  • mips64-none
  • mips64el-linux
  • mipsel-linux
  • mipsel-netbsd
  • mmix-mmixware
  • msp430-none
  • or1k-none
  • powerpc-netbsd
  • powerpc-none
  • powerpc64-linux
  • powerpc64le-linux
  • powerpcle-none
  • riscv32-linux
  • riscv32-netbsd
  • riscv32-none
  • riscv64-linux
  • riscv64-netbsd
  • riscv64-none
  • rx-none
  • s390-linux
  • s390-none
  • s390x-linux
  • s390x-none
  • vc4-none
  • wasm32-wasi
  • wasm64-wasi
  • x86_64-cygwin
  • x86_64-darwin
  • x86_64-freebsd
  • x86_64-genode
  • x86_64-linux
  • x86_64-netbsd
  • x86_64-none
  • x86_64-openbsd
  • x86_64-redox
  • x86_64-solaris
  • x86_64-windows