Read composition options

The composition analysis's options, pages and result state.

Usage

cellucid_analysis_composition_get(viewer, in_ = "panel")

Arguments

viewer

A viewer cellucid_view() or cellucid_serve() returned.

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 analysis, computed_on (What the result was computed on), has_result, in, options, pages, running, stale (The result no longer matches its inputs (the reasons say what changed)), stale_reasons. Cells in it are original positions (0-based rows of the dataset's obs).

Details

The viewer's action analysis.composition.get (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_composition_get(viewer)
  print(request)
  # cellucid_action_result(request) waits for what it read.
  cellucid_stop(viewer)
}