Skip to contents

Set a visible range

cellucid_filter_continuous_range.Rd

Show only the cells whose value of a continuous field or gene lies in [min, max]; the colours follow when they are rescaled to the range.

Usage

cellucid_filter_continuous_range(viewer, field, min, max)

Arguments

viewer

A viewer cellucid_view() or cellucid_serve() returned.

field

The continuous field or gene the view in focus is coloured by, by name. A named list. Required.

source

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

min

A number. Required.

max

A number. 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.continuous.range (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, colors.

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