cells_suggest: Suggest Cell Matches Based on Query Values

View source: R/cells.R

cells_suggestR Documentation

Suggest Cell Matches Based on Query Values

Description

This function communicates with the 'Genular' API to suggest cell matches based on an array of query values. It sends a POST request with the query values and retrieves suggested cell matches, including details and scores.

Usage

cells_suggest(queryValues, responseType = "json", debug = 0, options = list())

Arguments

queryValues

A character vector of cell names or identifiers to find matches for.

responseType

A character string indicating the type of response to expect ('json' or 'csv').

debug

An integer value indicating whether to enable debug mode (1) or not (0).

options

A list that specifies the API endpoint, api_key, timeout duration, and user agent string, with default values preset for the 'Genular' API cell suggestion endpoint.

Value

A list containing suggested cell matches, each with associated details like keys, values, search scores, and expression marker scores.

Examples

queryValues <- c("endothelial cell", "T cell")
cell_suggest_results <- cells_suggest(queryValues)
print(cell_suggest_results)

genular documentation built on Oct. 19, 2024, 9:07 a.m.