R/name.R

In ropensci/charlatan: Make Fake Data

#' Create fake person names
#'
#' @export
#' @template params
#' @param locale (character) the locale to use. See
#' `PersonProvider$new()$allowed_locales()` for locales supported
#' (default: en_US)
#' @param messy (logical) make some messy data. Default: `FALSE`
#' @seealso [PersonProvider_en_US]
#' @examples
#' ch_name()
#' ch_name(10)
#' # or even ch_name(500)
#'
#' ch_name(locale = "fr_FR", n = 10)
#' ch_name(locale = "fr_CH", n = 10)
#' ch_name(locale = "fa_IR", n = 10)
#' ch_name(locale = "fi_FI", n = 10)
ch_name <- function(n = 1, locale = NULL, messy = FALSE) {
  assert(n, c("integer", "numeric"))
  if (is.null(locale)) {
    locale <- "en_US"
  }
  pp <- cr_loc_spec_provider("PersonProvider", locale)
  if (!is.logical(messy)) {
    stop("Messy should be TRUE, or FALSE", call. = FALSE)
  }
  pp$change_messy(messy)
  if (n == 1) {
    pp$render()
  } else {
    replicate(n, pp$render())
  }
}