R/cat_function.R

In primer: Functions and Data for the Book, a Primer of Ecology with R

#' A Cat Function
#'
#' This function allows you to express your love of cats.
#' @param love Do you love cats? Defaults to TRUE.
#' @keywords cats
#' @export
#' @author Hilary Parker
#' @examples
#' cat_function()
cat_function <- function(love=TRUE){
  ## from Hilary Parker
  if(love==TRUE){
    print("I love cats!")
  }
  else {
    print("I am not a cool person.")
  }
}