Skip to contents

Stop an analysis

cellucid_analysis_cancel.Rd

Stop a running analysis; what it was showing stays, nothing else changes.

Usage

cellucid_analysis_cancel(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 what it read: a list of stopped (False when it was not running). Cells in it are original positions (0-based rows of the dataset's obs).

Details

The viewer's action analysis.cancel (Analysis). It reads, and changes nothing: it makes no step of the history.

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_cancel(viewer, analysis = "markers")
  print(request)
  # cellucid_action_result(request) waits for what it read.
  cellucid_stop(viewer)
}