epivizChart: Initialize an 'EpivizChart' object to visualize in viewer or...

In briangottfried/epivizrChart: R interface to epiviz web components

Description

Initialize an EpivizChart object to visualize in viewer or knit to HTML.

Usage

epivizChart(
  data_obj = NULL,
  measurements = NULL,
  datasource_name = NULL,
  parent = NULL,
  chart = NULL,
  chr = NULL,
  start = NULL,
  end = NULL,
  settings = NULL,
  colors = NULL,
  ...
)

Arguments

data_obj	A data object that will register to an EpivizData object.
measurements	An EpivizMeasurement object.
datasource_name	A name for the datasource. For example, "Mean by Sample Type".
parent	An object of class EpivizEnvironment or EpivizNavigation to append the chart within.
chart	The chart type to be visualized: "BlocksTrack", HeatmapPlot", "LinePlot", "LineTrack", "ScatterPlot", "StackedLinePlot", "StackedLineTrack".
chr	The chromosome to filter on, e.g., chr="chr11".
start	The start location, e.g., start=110800000.
end	The end location, e.g., end=130383180.
settings	List of settings, e.g., list(title="Blocks Chart").
colors	List of colors. When chart is rendered to html this will be converted to a string encoded as JSON
...	Additional arguments passed to epivizrData::register, e.g., type="bp", columns=c("normal, cancer").

Value

An object of class EpivizChart.

Examples

data(tcga_colon_blocks)
start <- 99800000
end <- 103383180
blocks_track <- epivizChart(tcga_colon_blocks, chr="chr11", start=start, end=end)
# See package vignette for more examples.

briangottfried/epivizrChart documentation built on Aug. 2, 2021, 3:13 a.m.