Skip to contents

Archive a branch

cellucid_history_branch_archive.Rd

Hide a branch from the graph and the pickers, or show it again; it is kept and can be shared. Main cannot be archived.

Usage

cellucid_history_branch_archive(viewer, branch, archived, tracker)

Arguments

viewer

A viewer cellucid_view() or cellucid_serve() returned.

branch

A branch by its name or its id (history_summary lists them). Text (at least 1 character). Required.

archived

TRUE or FALSE. Required.

tracker

A tracker by its name or its id (history_summary lists them); the tracker in use 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 archived, branch, journal.

Details

The viewer's action history.branch.archive (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_branch_archive(viewer,
      archived = TRUE, branch = "Main")
  print(request)
  # cellucid_action_result(request) waits for its outcome.
  cellucid_stop(viewer)
}