R/dataset_page_browser.R

In seandavi/RefineBio: The bridge between refine.bio and Bioconductor

#' Open a webpage for the given dataset
#'
#' This function will open a browser window to the RefineBio dataset page
#' for the given dataset. This is a convenience function for users who
#' want to quickly view the dataset page for a given dataset.
#'
#' @param dataset The dataset ID or `rb_dataset` object
#'
#' @author Sean Davis <seandavi@gmail.com>
#'
#' @return the dataset page URL (invisibly)
#'
#' @examples
#' \dontrun{
#' dataset_page_browser(dataset)
#' }
#'
#' @export
dataset_page_browser <- function(dataset) {
  dataset_id <- .dataset_id_from_args(dataset)
  if (interactive() && !Sys.getenv("TESTTHAT") == "true") {
    utils::browseURL(sprintf("https://www.refine.bio/dataset/%s", dataset_id))
  }
  invisible(sprintf("https://www.refine.bio/dataset/%s", dataset_id))
}