Skip to contents

Replay a saved history

cellucid_history_replay.Rd

Apply a saved state's branch (its main branch when left out) again here, step by step by name, in a new tracker linked to it; with a mapping, other names are used for fields, categories and genes. The report says what did not match.

Usage

cellucid_history_replay(viewer, saved, branch, mapping, name, tracker)

Arguments

viewer

A viewer cellucid_view() or cellucid_serve() returned.

saved

A saved state of this browser (history_saved_list). Text (at least 1 character). Required.

branch

Its branch; its main branch when left out. Text (at least 1 character). Left out unless given (the viewer then chooses as its own control does).

mapping

Names to use in place of the recorded ones, each from its recorded name (the replay report offers them: a step's missing names what matched nothing here). A category is named by its field's recorded key. A named list. Left out unless given (the viewer then chooses as its own control does).

fields

obs fields: recorded key → key here. A vector or list of a named list. Required.

genes

Genes: recorded name → name here. A vector or list of a named list. Required.

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).

tracker

Its tracker, by name or id; its tracker shown 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 its outcome: a list of report (Every step replayed and what became of it), tracker.

Details

The viewer's action history.replay (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_replay(viewer, saved = "state-1")
  print(request)
  # cellucid_action_result(request) waits for its outcome.
  cellucid_stop(viewer)
}