Skip to contents

Colour the cells by a field or gene

cellucid_color_by.Rd

Colour the view in focus by a column of the cells (source "obs") or a gene (source "var"), reading it first when needed; null clears the colouring.

Usage

cellucid_color_by(viewer, field)

Arguments

viewer

A viewer cellucid_view() or cellucid_serve() returned.

field

The field or gene by name; null colours the cells by nothing. A named list or NULL. Required.

source

"obs" for a column of the cells, "var" for a gene. One of "obs", "var". 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 color.by (Colours). It changes what the viewer shows: one step of the viewer's history, labelled as R's, undone like any other. The state it can change: active-field, filters, colors.

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_color_by(viewer, field = list(key = "cell_type",
      source = "obs"))
  print(request)
  # cellucid_action_result(request) waits for its outcome.
  cellucid_stop(viewer)
}