Skip to contents

Show an embedding

cellucid_view_embedding_set.Rd

Show one enabled embedding in a view; the view keeps it when the data mapping changes its defaults.

Usage

cellucid_view_embedding_set(viewer, view, embedding)

Arguments

viewer

A viewer cellucid_view() or cellucid_serve() returned.

view

A view: "View N" as the Compare views list numbers its rows (the live view is View 1 while it is shown, the kept views follow in the order they were kept). Text. Required.

embedding

An embedding: the obsm array and the columns of it plotted. A named list. Required.

key

The obsm key, "X_umap". Text (at least 1 character). 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 view.embedding.set (Views). 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: views, camera.

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_view_embedding_set(viewer, embedding = list(columns = c(0,
      1), key = "X_umap"), view = "View 1")
  print(request)
  # cellucid_action_result(request) waits for its outcome.
  cellucid_stop(viewer)
}