Skip to contents

Choose what the detailed analysis plots

cellucid_analysis_detailed_set.Rd

The variable the detailed analysis plots (a field or a gene, by name, or none), the plot, and options of that plot (only those given); it updates by itself.

Usage

cellucid_analysis_detailed_set(viewer, in_ = "panel", plot, plot_options, variable)

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.

plot

The plot, by its id as the Plot select offers it for the variable's kind. Text (at least 1 character). Left out unless given (the viewer then chooses as its own control does).

plot_options

Options of the plot, each by its name and value. A vector or list of a named list (at least 1 item). Left out unless given (the viewer then chooses as its own control does).

variable

What to plot: a column of the cells (categorical_obs, continuous_obs) or a gene (gene_expression) by name, or null for nothing. Either NULL; or a named list. Left out unless given (the viewer then chooses as its own control does).

type

One of "categorical_obs", "continuous_obs", "gene_expression". Required.

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.detailed.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_detailed_set(viewer, variable = list(key = "cell_type",
      type = "categorical_obs"))
  print(request)
  # cellucid_action_result(request) waits for its outcome.
  cellucid_stop(viewer)
}