Turn a filter on or off

Turn a field's category, range or outlier filter off (its settings kept) or on again.

Usage

cellucid_filter_enable(viewer, field, kind, enabled)

Arguments

viewer

A viewer cellucid_view() or cellucid_serve() returned.

field

The field or gene whose filter it is, by name. A named list. Required.

source

"obs" for a column of the cells, "var" for a gene. One of "obs", "var". Required.

kind

One of "category", "continuous", "outlier". Required.

enabled

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 filter.enable (Filters). 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: 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_filter_enable(viewer, enabled = FALSE,
      field = list(key = "cell_type", source = "obs"),
      kind = "category")
  print(request)
  # cellucid_action_result(request) waits for its outcome.
  cellucid_stop(viewer)
}