R/geneLists.R

In soderling-lab/geneLists: tools for mapping gene identifiers and a collection of gene lists in a universal format

#' geneLists
#'
#' list all available datasets, search for a dataset given a tag.
#'
#' @param none
#'
#' @return
#'
#' @author Tyler W Bradshaw, \email{twesleyb10@gmail.com}
#'
#' @references none
#'
#' @keywords
#'
#' @export
#'
#' @examples
#' geneLists()
geneLists <- function(pattern = NULL) {
  # List all available geneLists.
  gene_lists <- data(package = "geneLists")$results[, "Item"]
  names(gene_lists) <- NULL
  if (!is.null(pattern)) {
    # If provided, search for user specified pattern.
    return(gene_lists[grep(pattern, gene_lists)])
  } else {
    # Otherwise, return all available datastes.
    return(gene_lists)
  }
}