Skip to contents

Rename a field

cellucid_field_rename.Rd

Give a column of the cells or a gene another name; its original name stays known, and renaming it back to that name restores it.

Usage

cellucid_field_rename(viewer, field, name)

Arguments

viewer

A viewer cellucid_view() or cellucid_serve() returned.

field

A field by name: source "obs" for a column of the cells, "var" for a gene; key is the name as shown. A named list. Required.

source

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

name

A field name: not empty, unique among the fields shown. Text (at least 1 character). 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 field.rename (Fields). 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: field-overlays, active-field, filters, colors, highlights, views.

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