R/hi.R

In gomulki/Snowfall: Demonstration package

#' Start a conversation
#'
#' This function will produce a moduated greeting, useful in starting
#' conversations.
#'
#' @param who character(1) Name of person to be greeted.
#'
#' @param how character(1) (optional) How the person is to be greeted. Options
#'    include "shout", "whisper", or "asis".
#'
#' @return A character(1) vector containing the appropriate greeting.
#' @examples
#' hi("Dick")
#' hi("Dick", "shout")
#'
#' @export
hi <- function(who, how=c("shout","whisper","asis")) {
  stopifnot(is.character(who),length(who) == 1,
            !anyNA(who),nzchar(who))
  how <- match.arg(how)
  fun <- switch(how,
                shout=toupper, whisper=tolower, asis=identity,
                )
  paste("hi", fun(who), "how are you?")
}