Skip to contents

Run an analysis

cellucid_analysis_run.Rd

Run an analysis with its options and pages, and wait for its result.

Usage

cellucid_analysis_run(viewer, analysis, in_ = "panel")

Arguments

viewer

A viewer cellucid_view() or cellucid_serve() returned.

analysis

An analysis with a Run button. One of "markers", "differential", "dotplot", "signature", "composition", "correlation". Required.

in_

Either exactly "panel" (The Analysis panel); or a whole number (at least 1) (A floating analysis window, by its number (1 is the first open)). Default "panel", the viewer's own. Sent as the parameter in.

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.run (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.

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_run(viewer, analysis = "markers")
  print(request)
  # cellucid_action_result(request) waits for its outcome.
  cellucid_stop(viewer)
}