R/dbl_units.R

In jameelalsalam/sunits: Simple Unitful Double Vectors

#' Simple Double w/ Units Class
#'
#' @param x a double
#' @param units character representing the units (may be mixed)
#' @import vctrs
#' @return record-style s3 `sunits` object
new_sunits_dbl <- function(value = double(), units = character()) {
  vec_assert(value, double())
  vec_assert(units, character())

  new_vctr(
    value,
    "units" = units,
    class = "sunits_dbl"
  )
}

format.sunits_dbl <- function(x, ...) {
  glue::glue_data(
    .x = list(
      .value = format(vec_data(x)),
      .units = stringr::str_c(" ", attr(x, "units"))),
    "{.value}{.units}", .na = "")
}

validate_sunits_dbl <- function(x) {
  if(FALSE) stop("Undefined error.")
}

sunits_dbl <- function(x, units = NA_character_) {
  new_sunits_dbl(
    value = vec_cast(x, double()),
    units = vec_recycle(units, vec_size(x))
  )
}