Read values of cells

The values of named cells (original positions) in each field or gene asked for.

Usage

cellucid_cells_values(viewer, cells, fields)

Arguments

viewer

A viewer cellucid_view() or cellucid_serve() returned.

cells

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). Required.

fields

A vector or list of a named list (at least 1 item). 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 what it read: a list of cells (The cells asked for that are open, in the order asked), columns, not_open (Cells asked for that are not open (a subsample)). Cells in it are original positions (0-based rows of the dataset's obs).

Details

The viewer's action cells.values (Dataset). It reads, and changes nothing: it makes no step of the history.

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_values(viewer, cells = 1,
      fields = list(list(key = "cell_type", source = "obs")))
  print(request)
  # cellucid_action_result(request) waits for what it read.
  cellucid_stop(viewer)
}