In epiviz/epivizrData: Data Management API for epiviz interactive visualization app

The r Biocpkg("epivizrData") packages includes methods supporting serving data for visualization applications of data from R/Bioconductor objects. It is primarily used to serve data from interactive R/Bioconductor sessions to the epiviz JS application http://epiviz.github.io. These functions have been extracted from the r Biocpkg("epivizr") into its own package for easier use and maintenance.

It is designed to receive and send requests through WebSocket connections provided by the r Biocpkg("epivizrServer").

Usage

The general pattern to use this package is to create an EpivizDataMgr object using the createMgr function. Once the manager is created, data objects, which provide measurements to a visualization application can be added using the add_measurements method.

library(epivizrData)
library(GenomicRanges)

server <- epivizrServer::createServer(port=7123L)
data_mgr <- epivizrData::createMgr(server)

## add measurements from a GRanges object
gr <- GRanges("chr10", IRanges(start=1:1000, width=100), score=rnorm(1000))
data_mgr$add_measurements(gr, "example_gr", type="bp", columns="score")

See ?epivizrData::register for supported object types and options when adding data. For details on usage within the epiviz visualization app see the r Biocpkg("epivizr") package vignette.

epiviz/epivizrData documentation built on Oct. 9, 2021, 12:19 a.m.