R/adverbial.R

In rossellhayes/nombre: Number Names

#' Convert numbers to adverbial character vectors (once, twice, three times)
#'
#' @param x A numeric vector
#' @param thrice A logical of length one.
#'     If `TRUE`, the adverbial of `3` will be "thrice".
#'     If `FALSE`, the adverbial of `3` will be "three times".
#'     Defaults to `FALSE`.
#' @param ... Additional arguments passed to [cardinal()]
#'
#' @return A character vector of the same length as `x`
#' @family number names
#' @export
#' @example examples/adverbial.R

adverbial <- function(x, thrice = FALSE, ...) {
  if (!length(x))                 return(character(0))
  if (all(is.na(x) & !is.nan(x))) return(as.character(x))
  if (!is.numeric(x))             stop("`x` must be a numeric vector")
  if (length(thrice) != 1)        stop("`thrice` must be length one")
  if (!is.logical(thrice) | is.na(thrice))
    stop("`thrice` must be either `TRUE` or `FALSE`")

  numeric <- x
  na      <- is.na(x)

  adv <- paste(cardinal(x, ...), "times")

  adv[!na & abs(x) == 1] <- str_replace_all(
    adv[!na & abs(x) == 1], "one times$", "once"
  )
  adv[!na & abs(x) == 2] <- str_replace_all(
    adv[!na & abs(x) == 2], "two times$", "twice"
  )

  if (thrice) {
    adv[!na & abs(x) == 3] <- str_replace_all(
      adv[!na & abs(x) == 3], "three times$", "thrice"
    )
  }

  adv[is.na(x)]  <- NA
  adv[is.nan(x)] <- NaN

  args        <- as.list(match.call()[-1])
  args[["x"]] <- NULL

  structure(
    adv,
    numeric = numeric,
    nombre  = "adverbial",
    args    = args,
    class   = c("nombre", "character")
  )
}

#' @rdname adverbial
#' @export

nom_adv <- adverbial

#' @rdname adverbial
#' @export

nom_times <- adverbial