Skip to contents

Read the dataset summary

cellucid_dataset_summary.Rd

The open dataset: its name, citation, how many cells (and how many are open), genes, embeddings and fields.

Usage

cellucid_dataset_summary(viewer)

Arguments

viewer

A viewer cellucid_view() or cellucid_serve() returned.

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 cells, citation, embeddings, fields, genes, id (The dataset's id where it has one), name, source (Where it was opened from (a sample, a link, a local file, a notebook)). Cells in it are original positions (0-based rows of the dataset's obs).

Details

The viewer's action dataset.summary (Dataset). 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_dataset_summary(viewer)
  print(request)
  # cellucid_action_result(request) waits for what it read.
  cellucid_stop(viewer)
}