R/hello.R

In kedelaure/Hello: Hello: says hello in different languages

#' Hello World
#'
#' `hello` says _"hello"_ in the user-specified language. The user is asked to give her/his name so that the hello message gets personalized.
#'
#' @param
#' who a `character` vector of length 1 that specifies the name of the person to whom the message is addressed.
#'
#' @param
#' lang a `character` vector of length 1 that specifies the preferred language. Default to "EN" for English. Other possible values include "FR" for French, "IT"  for Italian, "ES" for Spanish, or "DE" for German. Case is ignored.
#'
#' @param
#' LangData an optional data.frame with two columns each of mode `character`. The first column gives the language codes and the second column gives the corresponding "hello" word. Default to `language`.
#'
#' see `?language`
#'
#' @return
#' a `character` vector with a personalized _"hello"_ message.
#'
#' @examples
#' hello("James")
#' hello("Amelia", "Es")
#'
#' @importFrom stringr str_c
#'
#' @export
#'
hello <- function(who, lang = "EN", LangData = language) {
  if (!exists("who", mode = "character") | length(who) > 1) stop("Please enter a valid namea; see ?hello")

  LangData <- data.frame(LangData)

  if (ncol(LangData) > 2) stop("Please enter a valid LangData; see ?hello")

  colnames(LangData) <- c("code", "hello")

  if ((mode(LangData$code) != "character") | (mode(LangData$hello) != "character")) stop("Please enter a valid LangData; see ?hello")

  llang <- tolower(lang)

  hello <- subset(LangData, LangData$code==llang)[[2]]

  cat(
    ifelse(
      length(hello) == 1,
      stringr::str_c(hello, ", ", who, "!", sep = ""),
      stringr::str_c("Sorry, ", who, ", ", "your language ", "('", lang, "') ", "is not available!", sep = "")
    )
  )
}