Skip to contents

Hide or show cells

cellucid_cells_visibility_set.Rd

Hide or show cells one by one in the selected view, on top of every filter.

Usage

cellucid_cells_visibility_set(viewer, cells, visible)

Arguments

viewer

A viewer cellucid_view() or cellucid_serve() returned.

cells

Either cells: 1-based positions, TRUE/FALSE for every cell, or the cell names of the object the viewer shows, each once (sent as original positions); or NULL (Every cell). Required.

visible

true to show them, false to hide them. TRUE or FALSE. 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 cells.visibility.set (Cells). 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: visibility.

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_cells_visibility_set(viewer, cells = c(0,
      1, 2), visible = FALSE)
  print(request)
  # cellucid_action_result(request) waits for its outcome.
  cellucid_stop(viewer)
}