R/hello.R

In 24sharkS/OpensMsForR: OpenMS for R (Title Case)

# Hello, world!
#
# This is an example function named 'hello'
# which prints 'Hello, world!'.
#
# You can learn more about package authoring with RStudio at:
#
#   http://r-pkgs.had.co.nz/
#
# Some useful keyboard shortcuts for package authoring:
#
#   Install Package:           'Ctrl + Shift + B'
#   Check Package:             'Ctrl + Shift + E'
#   Test Package:              'Ctrl + Shift + T'

#' @title Hello World function
#'
#' @description Welcomes User
#'
#' @param str The user name
#'
#' @return Output from \code{\link{print}}
#' @export
#'
#' @examples
#' hello("Mikey")
#' \dontrun{
#' hello("Boss")
#' }
#'
hello <- function(str){
  print(paste("Welcome" ,str, "this is a demo for this library!"))
}