Skip to contents

Rename a branch

cellucid_history_branch_rename.Rd

Give a branch another name, unique in its tracker.

Usage

cellucid_history_branch_rename(viewer, branch, name, 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.

name

A name, unique among its kind (compared without case and extra spaces); no length limit. Text (at least 1 character). 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 branch, journal (Its Recently changed entry).

Details

The viewer's action history.branch.rename (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_rename(viewer, branch = "Main",
      name = "Without alpha")
  print(request)
  # cellucid_action_result(request) waits for its outcome.
  cellucid_stop(viewer)
}