R/bioc-version.R

Defines functions wood_bioc_version

Documented in wood_bioc_version

#' Get available package version in Bioconductor
#'
#' @description This function queries Bioconductor for the code of the available
#' version of the selected package for given Bioconductor release.
#'
#' @template package
#' @template bioc-release
#'
#' @return A single string with a version code.
#'
#' @examplesIf !woodendesc:::is_cran_check()
#' wood_bioc_version("Biostrings")
#'
#' # What's coming next?
#' wood_bioc_version("Biostrings", release = "devel")
#' # Can query releases as old as 1.8:
#' wood_bioc_version("Biostrings", release = "1.8")
#'
#' @family bioc
#' @family versions
#' @export
wood_bioc_version <- function(package, release = "release") {
  assert_param_package(package)
  assert_param_bioc_release(release)
  validate_bioc_release(release)

  desc <- bioc_PACKAGES_cache(release)[[package]]

  validate_bioc_package(desc, package, release)

  desc[["Version"]]
}
ErdaradunGaztea/woodendesc documentation built on Feb. 1, 2025, 2:26 a.m.