Skip to contents

Collapse or expand an analysis window

cellucid_analysis_window_collapse.Rd

Fold a floating analysis window to its title bar, or unfold it again; its analysis is kept.

Usage

cellucid_analysis_window_collapse(viewer, window, collapsed)

Arguments

viewer

A viewer cellucid_view() or cellucid_serve() returned.

window

A floating analysis window, by its number (1 is the first open). A whole number (at least 1). Required.

collapsed

True folds it to its title bar, false unfolds it. TRUE or FALSE. Required.

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 (what it did, as names, counts and ids), or NULL when it had nothing to report; request$step is the history step it made.

Details

The viewer's action analysis.window.collapse (Analysis). It changes the viewer's layout: one step of the viewer's history, labelled as R's, undone like any other. The state it can change: layout.

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_analysis_window_collapse(viewer,
      collapsed = FALSE, window = 1)
  print(request)
  # cellucid_action_result(request) waits for its outcome.
  cellucid_stop(viewer)
}