Search the history

The steps whose label, parameters, notes or bookmark match, filtered by who took them, their kind, the part of the state they changed, notes, bookmarks and flags.

Usage

cellucid_history_search(
  viewer,
  bookmarked,
  by,
  domain,
  flagged,
  has_note,
  kind,
  step_kind,
  text,
  tracker
)

Arguments

viewer

A viewer cellucid_view() or cellucid_serve() returned.

bookmarked

TRUE or FALSE. Left out unless given (the viewer then chooses as its own control does).

by

Who took them. One of "person", "agent", "python", "r", "replay", "outside". Left out unless given (the viewer then chooses as its own control does).

domain

The part of the state they changed. One of "cells", "mapping", "field-overlays", "gene-sets", "views", "active-field", "filters", "colors", "visibility", "highlights", "camera", "camera-path", "settings", "analysis", "layout". Left out unless given (the viewer then chooses as its own control does).

flagged

Stale, or no longer applying. TRUE or FALSE. Left out unless given (the viewer then chooses as its own control does).

has_note

TRUE or FALSE. Left out unless given (the viewer then chooses as its own control does).

kind

What their action changes. One of "state", "view", "layout". Left out unless given (the viewer then chooses as its own control does).

step_kind

What they are: root, action, outside (changed outside an action) or squashed. One of "root", "action", "outside", "squashed". Left out unless given (the viewer then chooses as its own control does).

text

Words to find (any case). Text (at least 1 character). 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 steps (The matching steps, in step order), total (Steps in the tracker), tracker. Cells in it are original positions (0-based rows of the dataset's obs).

Details

The viewer's action history.search (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_search(viewer)
  print(request)
  # cellucid_action_result(request) waits for what it read.
  cellucid_stop(viewer)
}