Skip to contents

Add a note

cellucid_history_note_add.Rd

Write a note on a step, a branch, a turn or a tracker. End each turn that changed something with a one-line summary note on the turn.

Usage

cellucid_history_note_add(viewer, target, text, from_reply = FALSE)

Arguments

viewer

A viewer cellucid_view() or cellucid_serve() returned.

target

What the note is on: a step, a branch, a group, a turn, or a tracker itself. Either a named list; or a named list; or a named list; or a named list; or a named list. 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). Required.

branch

A branch by its name or its id (history_summary lists them). Text (at least 1 character). Required.

group

A group by its name or its id (history_summary lists them). Text (at least 1 character). Required.

turn

A turn, by its id (history_summary lists them). Text (at least 1 character). Required.

text

Markdown: emphasis, inline code and http(s) links; shown without HTML. Text (at least 1 character). Required.

from_reply

Taken from the agent's final reply (the turn summary written for an agent that wrote none). TRUE or FALSE. Default FALSE, 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 journal, note.

Details

The viewer's action history.note.add (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_note_add(viewer, target = list(step = "s3"),
      text = "Top hits match the paper.")
  print(request)
  # cellucid_action_result(request) waits for its outcome.
  cellucid_stop(viewer)
}