Save the history in this browser

Keep the history (every tracker), the current state only, or the steps only as a named saved state of this browser (history_saved_list lists them; replay or load it later).

Usage

cellucid_history_save(viewer, content = "history", name, results = "include")

Arguments

viewer

A viewer cellucid_view() or cellucid_serve() returned.

content

history: the trackers and branches with their values; state: the current state only, without its history (one squashed step "Shared state"); steps: the steps only, no cells or values (a replay plan for any dataset). One of "history", "state", "steps". Default "history", the viewer's own.

name

Its name; the dataset's name and the time when left out. Text (at least 1 character). Left out unless given (the viewer then chooses as its own control does).

results

Analysis results: include them, or leave them out to compute again on open from their recorded inputs (smaller; always so for steps). One of "include", "recompute". Default "include", 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 bytes, content, name, saved (Its id (history_saved_list)), steps.

Details

The viewer's action history.save (History). It acts outside the viewer's state and history (a file the person receives in the browser, a publication, or what the browser keeps for later visits), which Undo does not take back: 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_save(viewer)
  print(request)
  # cellucid_action_result(request) waits for its outcome.
  cellucid_stop(viewer)
}