Skip to contents

Choose the fields of the quick analysis

cellucid_analysis_quick_set.Rd

The categorical columns whose composition and the continuous columns whose statistics the quick analysis shows (only the kinds given; before a choice it shows the first two of each); it updates by itself.

Usage

cellucid_analysis_quick_set(viewer, categorical, continuous, in_ = "panel")

Arguments

viewer

A viewer cellucid_view() or cellucid_serve() returned.

categorical

Categorical columns of the cells, by name (their composition). A vector or list of text (at least 1 character) (each once). Left out unless given (the viewer then chooses as its own control does).

continuous

Continuous columns of the cells, by name (their statistics). A vector or list of text (at least 1 character) (each once). Left out unless given (the viewer then chooses as its own control does).

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.quick.set (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_quick_set(viewer, categorical = "cell_type")
  print(request)
  # cellucid_action_result(request) waits for its outcome.
  cellucid_stop(viewer)
}