Skip to contents

Read the history

cellucid_history_get.Rd

The steps taken on this dataset, who took each (person, agent, notebook), branches and the step shown.

Usage

cellucid_history_get(
  viewer,
  all_branches = FALSE,
  branch,
  cursor,
  fields,
  limit = 200,
  since,
  tracker
)

Arguments

viewer

A viewer cellucid_view() or cellucid_serve() returned.

all_branches

Every branch, not only the path to the step shown. TRUE or FALSE. Default FALSE, the viewer's own.

branch

The path to this branch's tip (by its name or id) instead of the path to the step shown; not with all_branches. Text (at least 1 character). Left out unless given (the viewer then chooses as its own control does).

cursor

Where the page starts: the next of the last page (its last step's id); the first page when left out. Text (at least 1 character). Left out unless given (the viewer then chooses as its own control does).

fields

What to add to each step: params (each parameter in words), notes, bookmark. A vector or list of one of "params", "notes", "bookmark" (each once). Left out unless given (the viewer then chooses as its own control does).

limit

The steps of one page (200 when left out: well under what a tool result carries). A whole number (at least 1). Default 200, the viewer's own.

since

Only the steps recorded at or after this time (milliseconds since 1970: a step's "at"), so a second read lists what came since. A number. Left out unless given (the viewer then chooses as its own control does).

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 what it read: a list of branches, head (The step shown now), next (The cursor of the next page; null on the last), steps (One page: root first; parents before children), total (Steps on every page (the path to the step shown, or every branch)), tracker, trackers. Cells in it are original positions (0-based rows of the dataset's obs).

Details

The viewer's action history.get (History). It reads, and changes nothing: 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_get(viewer)
  print(request)
  # cellucid_action_result(request) waits for what it read.
  cellucid_stop(viewer)
}