SOUNDWidget-class: Create and use 'widgets' for consistent data presenation

In Bioconductor/SOUNDBoard: Statistically-informed Multi-Omics Reports for Tumor and Other Boards

Description

This page describes 'widgets' for representating and reporting elements of a SOUND Board Report. Each widget describes a particular component of the data, e.g., the 'metadata' about the case; a top table of differentially expressed genes, an interactive plot of variant effects. The widget provides a constructor method, as well as a 'render' method. Widgets themselves may perform considerable work when created, but render quickly. Widgets can be fully serialized.

Usage

sbresource(x)

SOUNDWidget(widget, save, load, report, ..., where = .GlobalEnv)

Arguments

x	A SOUNDWidget instance.
widget	character(1) widget class name
save	function for saving the widget to disk
load	function for loading the widget from disk
report	method used to display widget after loading (i.e., 'sbreport')
...	key-value pairs of case information. Arguments must be named and unique. Each value must be a scalar. When length(allowed_keys) != 0, names of keys must be in allowed_keys.
where	The environment in which to define a SOUNDWidget-derived class and methods.
allowed_keys	character() of allowed key names.

Bioconductor/SOUNDBoard documentation built on May 6, 2019, 7:52 a.m.