R/hello_world.R

In JoFAM/firsttest: A First Test Package for Illustration

#' The function hello world
#'
#' THis function solely demonstrates how to add a function to a package. I
#' can write something more here and here.
#'
#' This paragraph will appear under the heading Details.
#'
#' And this next one also
#'
#' @param who a character value that say who needs to be said hello. Defaults
#' to \code{'world'}.
#'
#' @return a character value.
#'
#' @examples
#'
#' hello_world("Joris")
#'
#' @export
hello_world <- function(who = "world"){
  out <- paste("Hello", who)
  out
}