Skip to contents

Revert a step

cellucid_history_step_revert.Rd

Add a step that puts back exactly what a step changed, when no later step on the path changed the same parts (else use Branch without a step).

Usage

cellucid_history_step_revert(viewer, step)

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.

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 (what it did, as names, counts and ids), or NULL when it had nothing to report; request$step is the history step it made.

Details

The viewer's action history.step.revert (History). It changes the viewer's state: one step of the viewer's history, labelled as R's, undone like any other. The state it can change: cells, mapping, field-overlays, gene-sets, views, active-field, filters, colors, visibility, highlights, camera, camera-path, settings, analysis, layout.

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_revert(viewer, step = "s3")
  print(request)
  # cellucid_action_result(request) waits for its outcome.
  cellucid_stop(viewer)
}