R/animal_sounds.R

In amzoss/test.package: What the Package Does (One Line, Title Case)

#' Animal sounds sentences
#'
#' @param animal A character string containing the name of the animal
#' @param sound A character string containing the sound the animal makes
#'
#' @return A sentences matching animals with their sounds
#'
#' @examples sound <- animal_sounds("lion","roar")
animal_sounds <- function(animal, sound) {
  assertthat::assert_that(
    assertthat::is.string(animal),
    assertthat::is.string(sound)
  )
  paste0("The ", animal, " says ", sound, "!")
}