List the fields

The cell annotations (obs fields) with their kind and, for a categorical one, how many categories it has.

Usage

cellucid_fields_list(viewer, kind, query)

Arguments

viewer

A viewer cellucid_view() or cellucid_serve() returned.

kind

Only fields of this kind. One of "categorical", "continuous". Left out unless given (the viewer then chooses as its own control does).

query

Only fields whose key contains this text (any case). Text (at least 1 character). Left out unless given (the viewer then chooses as its own control does).

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 fields. Cells in it are original positions (0-based rows of the dataset's obs).

Details

The viewer's action fields.list (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_fields_list(viewer)
  print(request)
  # cellucid_action_result(request) waits for what it read.
  cellucid_stop(viewer)
}