Skip to contents

Open an analysis

cellucid_analysis_open.Rd

Show an analysis in the Analysis panel, or open it in a new floating window with the panel's settings.

Usage

cellucid_analysis_open(viewer, analysis, window = FALSE)

Arguments

viewer

A viewer cellucid_view() or cellucid_serve() returned.

analysis

The analysis: markers (marker genes), differential (differential expression), dotplot, signature (gene signature), composition, quick, detailed, correlation. One of "markers", "differential", "dotplot", "signature", "composition", "quick", "detailed", "correlation". Required.

window

Open it in a new floating window. TRUE or FALSE. Default FALSE, the viewer's own.

Value

A cellucid_action_request, at once and invisibly: the action is sent now, or when the viewer's channel opens. cellucid_action_result(request) returns its outcome (what it did, as names, counts and ids), or NULL when it had nothing to report; request$step is the history step it made.

Details

The viewer's action analysis.open (Analysis). It changes the viewer's state: one step of the viewer's history, labelled as R's, undone like any other. The state it can change: analysis, layout.

See also

cellucid_act() sends any action by its type, and cellucid_action_result() collects its answer.

Examples

if (interactive() && requireNamespace("SeuratObject", quietly = TRUE)) {
  data("pbmc_small", package = "SeuratObject")
  viewer <- cellucid_view(SeuratObject::UpdateSeuratObject(pbmc_small))
  request <- cellucid_analysis_open(viewer, analysis = "markers")
  print(request)
  # cellucid_action_result(request) waits for its outcome.
  cellucid_stop(viewer)
}