Read a step

One step in full: its parameters, pseudocode, who took it and when, what it changed and read, its notes and bookmark, and why it is stale.

Usage

cellucid_history_step(viewer, step, tracker)

Arguments

viewer

A viewer cellucid_view() or cellucid_serve() returned.

step

A step, by its id (history_get lists the steps). Text. Required.

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 at, bookmark, branch, by (Who acted), children, code, group, id, kind, label, merged (Changes merged into it (a drag, a gesture)), ms (How long its action took), notes, params (Its parameters as the details show them (cells as counts)), parent, reads (The inputs its result depends on), reason, replay_of, shown (On the path to the step shown now), squashed, stale, status, touches, tracker, type, until, v. Cells in it are original positions (0-based rows of the dataset's obs).

Details

The viewer's action history.step (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_step(viewer, step = "s3")
  print(request)
  # cellucid_action_result(request) waits for what it read.
  cellucid_stop(viewer)
}