fetch_all_gene_search_results: Fetch All Pages of Gene Search Results

In genular: 'Genular' Database API

Fetch All Pages of Gene Search Results

Description

This function iteratively calls the gene_search function to retrieve all available search results across pages for a given query.

Usage

fetch_all_gene_search_results(
  queryFields,
  queryValues,
  fieldsFilter = c("geneID", "symbol", "crossReference.enseGeneID", "ontology.id",
    "ontology.term", "ontology.cat"),
  searchType = "or",
  orderBy = "geneID",
  sortDirection = "asc",
  responseType = "json",
  matchType = "exact",
  organismType = list(c(9606)),
  ontologyCategories = list(),
  limit = 5,
  debug = 0,
  options = list()
)

Arguments

queryFields	A character vector specifying the fields to search within the gene data.
queryValues	A numeric/character vector representing the values to search for within the specified fields.
fieldsFilter	A vector specifying which fields to include in the response.
searchType	Indicates whether to use 'and' or 'or' logic for multiple search conditions.
orderBy	Specifies which field to sort the results by.
sortDirection	Indicates the sort direction ('asc' or 'desc').
responseType	Indicates the type of response to expect ('json' or 'csv').
matchType	Indicates the type of match to perform ('exact' or 'regex').
organismType	A list of organism type IDs to filter the search results.
ontologyCategories	A list of ontology category IDs to filter the search results.
limit	The maximum number of results to return per page.
debug	An integer value indicating whether to enable debug mode (1) or not (0).
options	A list of additional options for the API request, including endpoint, api_key, timeout, and user-agent.

Value

A list of gene search results aggregated from all retrieved pages.

Examples

all_gene_results <- fetch_all_gene_search_results(
  queryFields = list(c("symbol")),
  queryValues = c("A1CF", "A2M", "A4GALT", "A4GNT"),
  fieldsFilter = c("geneID", "symbol", "crossReference.enseGeneID", 
                     "ontology.id", "ontology.term", "ontology.cat"),
  searchType = "or",
  orderBy = "geneID",
  sortDirection = "asc",
  responseType = "json",
  matchType = "exact",
  organismType = list(c(9606)),
  ontologyCategories = list(),
  limit = 5
)

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