R/pluralise.R

In verbaliseR: Make your Text Mighty Fine

#' Pluralise words if their accompanying number is not 1
#'
#' @param word A word which should be returned as plural if `count` is not equal to 1.
#' @param count A number to apply to `word`
#' @param plural How to make the plural; defaults to an "s" which is added at the end of the word.
#' Can be anything. See `add_or_swap`.
#' @param add_or_swap Choose between `add` (add the plural form (e.g. "s") onto the end; e.g. `house`
#' becomes `houses`) and `swap` (swap for the plural form; e.g. `mouse` becomes `mice`)
#' @param include_number Logical. If `TRUE`, the number will be turned into text, as per `num_to_text()` (if it is a whole number, )
#' @param sentence_start Logical. Defaults to `FALSE`, which results in only numbers 1-10 being written out in full.
#' If `TRUE`, numbers 11-999 are written out in full if included. (If `include_number` is `FALSE`, the first letter of `word` is capitalised.)
#' @param zero_or_no Prefered string to use where count == 0. Defaults to "no". Can be anything.
#' @param uk_or_us Only used if `include_number` == `TRUE`. Defaults to UK which adds an "and" between "hundred" and other numbers
#' (e.g. "One hundred and five"). If "US" is chosen, the "and" is removed (e.g. "One hundred five").
#' @param big_mark Passed to `num_to_text`. Defaults to "," (e.g. "1,999")
#'
#' @return A word which is pluralised or not based on the value of `count`
#' @export
#'
#' @examples pluralise("penguin", 3)
#' pluralise("bateau", 1234, "x")
#' pluralise("sheep", 333, "sheep", add_or_swap = TRUE, sentence_start =  TRUE)
#'
pluralise <- function(word,
                      count,
                      plural = "s",
                      add_or_swap = "add",
                      include_number = TRUE,
                      sentence_start = FALSE,
                      zero_or_no = "no",
                      uk_or_us = "UK",
                      big_mark = ","){

  if(count == 1) {
    output_string <- word
  } else {
    output_string <- ifelse(add_or_swap == "swap",
                          plural,
                          paste0(word, plural))
  }

  if(include_number == FALSE & sentence_start == TRUE) {
    output_string <- stringr::str_to_sentence(output_string)
  }

  if(include_number == TRUE) {
    output_string <- paste(
      num_to_text(number = count,
                  sentence_start = sentence_start,
                  zero_or_no = zero_or_no,
                  uk_or_us = uk_or_us,
                  big_mark = big_mark),
      output_string
    )
  }

  return(output_string)

}