Skip to contents

Purge a deleted field

cellucid_field_purge.Rd

Confirm a deletion: the field leaves Deleted fields and can no longer be restored there (undo still brings it back).

Usage

cellucid_field_purge(viewer, field)

Arguments

viewer

A viewer cellucid_view() or cellucid_serve() returned.

field

The deleted field by the name it had when deleted. A named list. 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 field.purge (Fields). 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: field-overlays, filters.

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