Skip to contents

Stop the guided tour

cellucid_history_tour_stop.Rd

Stop the guided tour, as its Stop button does: the history returns to the step shown before it began (unless the person made a step meanwhile).

Usage

cellucid_history_tour_stop(viewer)

Arguments

viewer

A viewer cellucid_view() or cellucid_serve() returned.

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), stopped (False when no tour was playing).

Details

The viewer's action history.tour.stop (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_tour_stop(viewer)
  print(request)
  # cellucid_action_result(request) waits for its outcome.
  cellucid_stop(viewer)
}