Skip to contents

Search the genes

cellucid_genes_search.Rd

Gene names matching what is typed, best first, as the gene search box ranks them.

Usage

cellucid_genes_search(viewer, query, limit = 20)

Arguments

viewer

A viewer cellucid_view() or cellucid_serve() returned.

query

Text (at least 1 character). Required.

limit

At most this many names. A whole number (at least 1). Default 20, 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 what it read: a list of genes, matches (How many genes match in all), total (How many genes the dataset has). Cells in it are original positions (0-based rows of the dataset's obs).

Details

The viewer's action genes.search (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_genes_search(viewer, query = "CD3")
  print(request)
  # cellucid_action_result(request) waits for what it read.
  cellucid_stop(viewer)
}