Size an analysis's expanded view

The size and splits an analysis's expanded view opens at, remembered per analysis; a person sets them by resizing it.

Usage

cellucid_analysis_size_set(viewer, analysis, expanded)

Arguments

viewer

A viewer cellucid_view() or cellucid_serve() returned.

analysis

The analysis: markers (marker genes), differential (differential expression), dotplot, signature (gene signature), composition, quick, detailed, correlation. One of "markers", "differential", "dotplot", "signature", "composition", "quick", "detailed", "correlation". Required.

expanded

The expanded view's box and its splits, in CSS pixels. A named list. Required.

height

A number (more than 0). Required.

optionsWidth

The options column. A number (more than 0). Required.

statsWidth

The statistics column. A number (more than 0). Required.

width

A number (more than 0). 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.size.set (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_size_set(viewer, analysis = "markers",
      expanded = list(footerHeight = 180, height = 600,
          optionsWidth = 260, statsWidth = 320, width = 900))
  print(request)
  # cellucid_action_result(request) waits for its outcome.
  cellucid_stop(viewer)
}