Skip to contents

Choose a colour map

cellucid_color_continuous_colormap.Rd

The colour map a continuous field or gene is drawn with.

Usage

cellucid_color_continuous_colormap(viewer, field, colormap)

Arguments

viewer

A viewer cellucid_view() or cellucid_serve() returned.

field

The continuous field or gene the view in focus is coloured by, by name. A named list. Required.

source

"obs" for a column of the cells, "var" for a gene. One of "obs", "var". Required.

colormap

The colour map by its id (viridis, magma, coolwarm, ...). One of "viridis", "plasma", "inferno", "magma", "cividis", "turbo", "twilight", "coolwarm", "bluered", "spectral", "rdylbu", "rdbu", "piyg", "prgn", "brbg", "seismic", "ylgnbu", "ylorrd", "ylorbr", "gnbu", "bupu", "rdpu", "purd", "orrd", "blues", "greens", "reds", "purples", "oranges", "greys", "heat", "hot", "cool", "jet", "rainbow", "ocean", "terrain", "spring", "summer", "autumn", "winter", "bone", "copper", "pink". 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 color.continuous.colormap (Colours). It changes what the viewer shows: one step of the viewer's history, labelled as R's, undone like any other. The state it can change: colors.

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_color_continuous_colormap(viewer,
      colormap = "viridis", field = list(key = "cell_type",
          source = "obs"))
  print(request)
  # cellucid_action_result(request) waits for its outcome.
  cellucid_stop(viewer)
}