Skip to contents

List the settings

cellucid_settings_list.Rd

Every setting of the sidebar with its label, section, kind, value, range or choices, and whether it can be changed now.

Usage

cellucid_settings_list(viewer, section)

Arguments

viewer

A viewer cellucid_view() or cellucid_serve() returned.

section

Only the settings of the sidebar section with this title (Visualization, Navigation, ...). 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 settings. Cells in it are original positions (0-based rows of the dataset's obs).

Details

The viewer's action settings.list (Settings). 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_settings_list(viewer)
  print(request)
  # cellucid_action_result(request) waits for what it read.
  cellucid_stop(viewer)
}