R/annotation_options.R

In recount3: Explore and download data from the recount3 project

#' List available annotation options for a given organism
#'
#' This function will return the available annotation options for a given
#' `organism`.
#'
#' @inheritParams locate_url
#'
#' @return A `character()` vector with the supported annotation options for the
#' given `organism`.
#' @export
#'
#' @examples
#'
#' annotation_options("human")
#' annotation_options("mouse")
annotation_options <- function(organism = c("human", "mouse")) {
    organism <- match.arg(organism)
    if (organism == "human") {
        options <- c(
            "gencode_v26",
            "gencode_v29",
            "fantom6_cat",
            "refseq",
            "ercc",
            "sirv"
        )
    } else if (organism == "mouse") {
        options <- c(
            "gencode_v23"
        )
    }
    return(options)
}