Skip to contents

Set correlation options

cellucid_analysis_correlation_set.Rd

Change options of the correlation analysis (only those given); nothing runs.

Usage

cellucid_analysis_correlation_set(viewer, options, in_ = "panel", show = FALSE)

Arguments

viewer

A viewer cellucid_view() or cellucid_serve() returned.

options

A named list. Required.

method

Method. One of "pearson", "spearman". Optional.

variableX

X axis: a field (continuous_obs, categorical_obs) or a gene (gene_expression) by key, or null. Either NULL; or a named list. Optional.

type

One of "continuous_obs", "gene_expression". Required.

variableY

Y axis: a field (continuous_obs, categorical_obs) or a gene (gene_expression) by key, or null. Either NULL; or a named list. Optional.

type

One of "continuous_obs", "gene_expression". Required.

in_

Either exactly "panel" (The Analysis panel); or a whole number (at least 1) (A floating analysis window, by its number (1 is the first open)). Default "panel", the viewer's own. Sent as the parameter in.

show

Also open it in the Analysis panel (with in "panel"), as another analysis's "send to" does. TRUE or FALSE. Default FALSE, the viewer's own.

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.correlation.set (Analysis). It changes the viewer's state: one step of the viewer's history, labelled as R's, undone like any other. The state it can change: analysis.

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_correlation_set(viewer,
      options = list())
  print(request)
  # cellucid_action_result(request) waits for its outcome.
  cellucid_stop(viewer)
}