Skip to contents

Highlight a category

cellucid_highlight_category.Rd

Add the cells of one category of a field, as the selected view shows them, as a group.

Usage

cellucid_highlight_category(viewer, field, category, color, page)

Arguments

viewer

A viewer cellucid_view() or cellucid_serve() returned.

field

A categorical field, by name. A named list. Required.

source

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

category

The category, by its label as the legend shows it. Text or a number or TRUE or FALSE. Required.

color

The colour of the page the group goes on. With page, the colour of the page made (an existing page must already have it). Without, the page shown when it has this colour, else the first page that has it, else a new page of it. Text. Left out unless given (the viewer then chooses as its own control does).

page

The page the group goes on, by name; a page of that name is made when there is none. Omitted: the page shown, or with color, a page of that colour. 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 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 highlight.category (Highlights). 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: highlights.

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