Skip to contents

Start another tracker

cellucid_history_tracker_start.Rd

Start a new tracker, an independent tree of steps on this dataset: from the dataset as opened (the default), or from what is shown.

Usage

cellucid_history_tracker_start(viewer, name, start = "opened")

Arguments

viewer

A viewer cellucid_view() or cellucid_serve() returned.

name

A name, unique among its kind (compared without case and extra spaces); no length limit. Text (at least 1 character). Left out unless given (the viewer then chooses as its own control does).

start

opened: the dataset as it was opened; shown: what is shown now. One of "opened", "shown". Default "opened", the viewer's own.

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: a list of head (The step shown now), tracker.

Details

The viewer's action history.tracker.start (History). It moves the viewer's history, as the person's Undo, Redo or a click on a step does: 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_tracker_start(viewer)
  print(request)
  # cellucid_action_result(request) waits for its outcome.
  cellucid_stop(viewer)
}