Skip to contents

Keep a gene set

cellucid_gene_set_save.Rd

A named list of genes, kept with the dataset for analyses and sessions; a later set of the same name replaces it.

Usage

cellucid_gene_set_save(viewer, name, genes, description = "")

Arguments

viewer

A viewer cellucid_view() or cellucid_serve() returned.

name

The set's name. Text (at least 1 character). Required.

genes

Gene names. A vector or list of text (at least 1 character) (at least 1 item). Required.

description

What the set is. Text. Default "", 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 gene-set.save (Genes). 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: gene-sets.

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_gene_set_save(viewer, genes = "x",
      name = "x")
  print(request)
  # cellucid_action_result(request) waits for its outcome.
  cellucid_stop(viewer)
}