Skip to contents

Branch here

cellucid_history_branch_create.Rd

Show a step and start a new branch from it with the next change (a branch exists from its first step); the name defaults to the next "Branch n".

Usage

cellucid_history_branch_create(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

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

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 from, head (The step shown now), pending (The name the next change's branch takes).

Details

The viewer's action history.branch.create (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_create(viewer, step = "s3")
  print(request)
  # cellucid_action_result(request) waits for its outcome.
  cellucid_stop(viewer)
}