Summarise the history

The history at a glance: trackers, branches (fork step, tip, steps, main, locked, archived), bookmarks, turns with their summaries, stale results and Recently deleted, without the steps. Read it before acting on the history.

Usage

cellucid_history_summary(viewer, tracker)

Arguments

viewer

A viewer cellucid_view() or cellucid_serve() returned.

tracker

A tracker by its name or its id (history_summary lists them); the tracker in use when left out. 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 what it read: a list of active_branch, bookmarks, branches (Every branch, in id order (archived ones flagged)), groups (Every group, in id order: a named run of consecutive steps of one branch), head (The step shown now), main_branch, pending, recently_deleted (Entries that can be undone), recording, stale (Results whose inputs changed since (history_stale lists them)), steps (Steps of the tracker, the root included), tracker, trackers (Every tracker not removed), turns. Cells in it are original positions (0-based rows of the dataset's obs).

Details

The viewer's action history.summary (History). It reads, and changes nothing: it makes no step of the history.

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_history_summary(viewer)
  print(request)
  # cellucid_action_result(request) waits for what it read.
  cellucid_stop(viewer)
}