R/argo-tech.R

In paleolimbot/argodata: Locate, Download, and Read Argo Ocean Float Data

#' Load Argo float meta
#'
#' Use `argo_tech_tech_param()` to extract information from Argo technical
#' spec NetCDF files. Use [argo_read_tech_tech_param()]
#' to extract information from a single previously-downloaded NetCDF file.
#'
#' @inheritParams argo_prof_levels
#'
#' @return A [tibble::tibble()] with one row per technical parameter
#'   per cycle and columns `file`, `n_tech_param`, `technical_parameter_name`,
#'   `technical_parameter_value`, and `cycle_number`.
#' @export
#' @rdname argo_tech
#'
#' @examples
#' with_argo_example_cache({
#'   argo_tech_tech_param("dac/csio/2900313/2900313_tech.nc")
#' })
#'
argo_tech_tech_param <- function(path, download = NULL, quiet = NA) {
  argo_read_many(
    assert_argo_tech_file,
    argo_read_tech_tech_param,
    path = path,
    vars = NULL,
    download = download,
    quiet = quiet,
    trim = TRUE
  )
}

#' Read Argo float technical parameters
#'
#' Use `argo_read_tech_tech_param()` to extract technical specifications from a
#' previously-downloaded Argo NetCDF file.
#'
#' @inheritParams argo_read_vars
#'
#' @return A [tibble::tibble()] with one row per technical parameter
#'   and columns `N_TECH_PARAM`, `TECHNICAL_PARAMETER_NAME`,
#'   `TECHNICAL_PARAMETER_VALUE`, and `CYCLE_NUMBER`.
#' @export
#' @rdname argo_read_meta
#'
#' @examples
#' tech_file <- system.file(
#'   "cache-test/dac/csio/2900313/2900313_tech.nc",
#'   package = "argodata"
#' )
#'
#' argo_read_tech_tech_param(tech_file)
#'
argo_read_tech_tech_param <- function(file, vars = NULL, quiet = FALSE) {
  argo_nc_read_simple(
    file,
    dims = "N_TECH_PARAM",
    quiet = quiet
  )
}

assert_argo_tech_file <- function(path) {
  argo_assert_path_type(path, "[0-9a-zA-Z]+_tech(_aux)?\\.nc$", "tech")
}