Skip to contents

Make the printable report

cellucid_history_report.Rd

The State panel's printable report of the branch shown up to the step shown (the dataset, the methods text, every step with who took it, its parameters, what it changed and its notes, then the pseudocode), as an .html file the person receives (asked first) or as its text; with pictures of the views after the steps chosen (a file only).

Usage

cellucid_history_report(viewer, as = "file", file, pictures = "none")

Arguments

viewer

A viewer cellucid_view() or cellucid_serve() returned.

as

file: an .html file downloaded to the person's computer, which they open, print or save as PDF; text: the same HTML document in the result (no pictures). One of "file", "text". Default "file", the viewer's own.

file

The file's name; the dataset's name and "history report" when left out. Text (at least 1 character). Left out unless given (the viewer then chooses as its own control does).

pictures

The steps that get a picture of the views after them (each is shown in turn and drawn, then the history returns to the step shown). A file only. Either one of "none", "default" (none; or default: the bookmarks, the last step of each group and the step shown); or a vector or list of text (at least 1 item, each once) (These steps of the branch shown). Default "none", the viewer's own.

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 as, branch, bytes (Its size), file (The file written (as file)), html (The report as one HTML document (as text)), pictures (Pictures in it), steps (Steps in it), to (The last step it covers, or null at the branch's tip), tracker.

Details

The viewer's action history.report (History). It acts outside the viewer's state and history (a file the person receives in the browser, a publication, or what the browser keeps for later visits), which Undo does not take back: it makes no step of the history.

When an agent (Claude, ChatGPT) runs it, the viewer asks the person first (writes-file); from R it is not asked.

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_report(viewer)
  print(request)
  # cellucid_action_result(request) waits for its outcome.
  cellucid_stop(viewer)
}