R: Reactive manipulations for Panel output

.retrieveOutput {iSEE}

R Documentation

Reactive manipulations for Panel output

Description

Respond to or request a re-rendering of the Panel output via reactive variables.

Usage

.retrieveOutput(panel_name, se, pObjects, rObjects)

.requestUpdate(panel_name, rObjects)

.requestCleanUpdate(panel_name, pObjects, rObjects)

.requestActiveSelectionUpdate(
  panel_name,
  session,
  pObjects,
  rObjects,
  update_output = TRUE
)

Arguments

`panel_name`	String containing the panel name.
`se`	A SummarizedExperiment object containing the current dataset.
`pObjects`	An environment containing global parameters generated in the `iSEE` app.
`rObjects`	A reactive list of values generated in the `iSEE` app.
`session`	The Shiny session object from the server function.
`update_output`	A logical scalar indicating whether to call `.requestUpdate` as well.

Details

.retrieveOutput should be used in the expression for rendering output, e.g., in .renderOutput. This takes care of a number of house-keeping tasks required to satisfy .renderOutput's requirements with respect to updating various fields in pObjects. It also improves efficiency by retrieving cached outputs that were used elsewhere in the app.

.requestUpdate should be used in various observers to request a re-rendering of the panel, usually in response to user-driven parameter changes in .createObservers.

.requestCleanUpdate is used for changes to protected parameters that invalidate existing multiple selections, e.g., if the coordinates change in a DotPlot, existing brushes and lassos are usually not applicable.

Value

.retrieveOutput will return the output of running .generateOutput for the current panel.

.requestUpdate will modify rObjects to request a re-rendering of the specified panel. .requestCleanUpdate will also remove all active/saved selections in the chosen panel.

.requestActiveSelectionUpdate will modify rObjects to indicate that the active multiple selection for panel_name has changed. If update_output=TRUE, it will also call request a re-rendering of the panel.

All .request* functions will invisibly return NULL.

Author(s)

Aaron Lun