specific-tours: UI-specific tour management utilities

In csoneson/SEE: Interactive SummarizedExperiment Explorer

UI-specific tour management utilities

Description

Utilities to manage the tours specific to individual UI elements for each Panel. This is done via a global tour cache that is updated by each Panel's interface-generating methods, so that developers can easily put the UI documentation next to the element definition.

Usage

.addSpecificTour(cls, field, fun, force = FALSE)

.getSpecificTours(cls)

.clearSpecificTours()

Arguments

cls	String containing the name of the Panel class containing the relevant UI element.
field	String containing the slot of the cls class that is controlled by the UI element.
fun	Function that accepts a string containing the encoded Panel name, and returns a data.frame compatible with rintrojs, i.e., with a element and intro column.
force	Logical scalar indicating whether fun should forcibly overwrite an existing function in the tour cache for cls and field.

Details

By default, .addSpecificTour will have no effect if a function is already registered for a particular combination of cls and field. However, users can force a replacement with force=TRUE.

.clearSpecificTours is intended for use by the iSEE app itself and should not be used by Panel methods.

Value

.addSpecificTour registers the provided function in the tour cache for the provided cls and field. A NULL is invisibly returned.

.getSpecificTours returns a list of registered tour-generating functions for the specified cls.

.clearSpecificTours removes all functions in the tour cache.

Author(s)

Aaron Lun

See Also

.selectInput.iSEE and friends, which provide modified UI elements that can be clicked to launch a helpful tour.

csoneson/SEE documentation built on Oct. 13, 2024, 10:19 a.m.