Skip to contents

Make a highlight page

cellucid_highlight_page_create.Rd

Add an empty highlight page and show it.

Usage

cellucid_highlight_page_create(viewer, color, name)

Arguments

viewer

A viewer cellucid_view() or cellucid_serve() returned.

color

The new page's colour; omitted, the next colour of the page palette. Text. Left out unless given (the viewer then chooses as its own control does).

name

The new page's name; omitted, the first free "Page N". 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.page.create (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_page_create(viewer)
  print(request)
  # cellucid_action_result(request) waits for its outcome.
  cellucid_stop(viewer)
}