Skip to contents

Bookmark a step

cellucid_history_bookmark_set.Rd

Give a step a bookmark name, unique in its tracker (jump to it by name), or remove it with null. Bookmark before destructive or heavy work.

Usage

cellucid_history_bookmark_set(viewer, step, name)

Arguments

viewer

A viewer cellucid_view() or cellucid_serve() returned.

step

A step of the tracker in use, by its id (history_get lists the steps). Text. Required.

name

The bookmark, or null to remove it. Text or NULL (at least 1 character). Required.

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 bookmark, journal, step.

Details

The viewer's action history.bookmark.set (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_bookmark_set(viewer, name = "Before reclustering",
      step = "s3")
  print(request)
  # cellucid_action_result(request) waits for its outcome.
  cellucid_stop(viewer)
}