R/cms_product_details.r

In CopernicusMarine: Search Download and Handle Data from Copernicus Marine Service Information

#' Obtain details for a specific Copernicus marine product
#'
#' `r lifecycle::badge('experimental')` Obtain details for a specific Copernicus marine product.
#' @inheritParams cms_download_subset
#' @param layer `r lifecycle::badge('deprecated')` Ignored and deprecated
#' @param variant `r lifecycle::badge('deprecated')` Ignored and deprecated
#' @param ... Ignored
#' @returns Returns a named `list` with product details.
#' @rdname cms_product_details
#' @name cms_product_details
#' @family product-functions
#' @examples
#' if (interactive()) {
#'   cms_product_details("GLOBAL_ANALYSISFORECAST_PHY_001_024")
#' }
#' @author Pepijn de Vries
#' @export
cms_product_details <- function(product, layer, variant, ...) {
  if (!missing(layer)) {
    rlang::warn(c("argument 'layer' in `cms_product_details()` is deprecated and ignored.",
                  i = "Please remove from your call"))
  }
  if (!missing(variant)) {
    rlang::warn(c("argument 'variant' in `cms_product_details()` is deprecated and ignored.",
                  i = "Please remove from your call"))
  }
  clients <- cms_get_client_info()
  stac_url <- gsub("/$", "", clients$catalogues[[1]]$stacRoot)
  if (is.null(clients)) return(NULL) else {
    product_url <- paste(
      stac_url,
      product,
      "product.stac.json",
      sep = "/"
    )
  }
  
  result <- .try_online({
    product_url |>
      httr2::request() |>
      httr2::req_perform()
  }, "product-catalogue")
  
  if (is.null(result)) return(NULL) else {
    result <- httr2::resp_body_json(result)
    attr(result, "stac_url") <- stac_url
    return(result)
  }
}