Skip to contents

Group steps

cellucid_history_group_create.Rd

Name a run of consecutive steps of one branch as a group (a folder; nothing is changed or merged). It holds whole turns; a step is in one group at most. Group a multi-step analysis under a short name.

Usage

cellucid_history_group_create(viewer, from, to, name)

Arguments

viewer

A viewer cellucid_view() or cellucid_serve() returned.

from

Its first step. Text. Required.

to

Its last step. Text. Required.

name

A name, unique among its kind (compared without case and extra spaces); no length limit. Text (at least 1 character). Required.

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 group, journal (Its Recently changed entry), steps (Steps in it).

Details

The viewer's action history.group.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_group_create(viewer, from = "s4",
      name = "QC", to = "s9")
  print(request)
  # cellucid_action_result(request) waits for its outcome.
  cellucid_stop(viewer)
}