R/case.R

In rmsharp/wordPuzzle: Word Search Puzzles in R

#' Returns the word either without change of folded to upper case depending on
#' the second argument of class logical.
#' 
#' @param word 1 element character vector with the word
#' @param upper_case a logical flag indicating whether or not the word is
#' folded to upper case or not. Defaults to \code{TRUE}.
#' @export
case <- function(word, upper_case = TRUE) {
  if (upper_case)
    word <- toupper(word)
  
  word
}