R/get_snp_ids_from_gene_name.R

Defines functions get_snp_ids_from_gene_name

Documented in get_snp_ids_from_gene_name

#' Get all the SNP IDs for a certain gene
#' @inheritParams default_params_doc
#' @return a character vector
#' @export
get_snp_ids_from_gene_name <- function(
  gene_name,
  verbose = FALSE
) {
  search_result <- rentrez::entrez_search(
    db = "SNP",
    term = paste0("", gene_name, "[Gene Name]"),
    retmax = 1000001, # Prevent the change to scientific notation
    config = httr::config(verbose = verbose)
  )
  Sys.sleep(1)
  # Check that we indeed have all results
  testthat::expect_equal(search_result$count, search_result$retmax)
  search_result$ids
}
richelbilderbeek/ncbi documentation built on July 9, 2023, 3:51 a.m.