Skip to contents

Edit a note

cellucid_history_note_edit.Rd

Change a note's text. An agent edits only its own notes; the person edits any.

Usage

cellucid_history_note_edit(viewer, note, text, tracker)

Arguments

viewer

A viewer cellucid_view() or cellucid_serve() returned.

note

A note, by its id (history_step and history_summary list them). Text. Required.

text

Markdown: emphasis, inline code and http(s) links; shown without HTML. 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 journal, note.

Details

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