R/function.R

In Pakillo/template: Generic template for data analysis projects structured as R packages

#' How to document functions.
#'
#' This is an example showing how to document functions to be included in the package.
#'
#' @export
#' @name examplefunction
#' @author Francisco Rodriguez-Sanchez
#' @param text Message to print.
#' @seealso \url{http://r-pkgs.had.co.nz/man.html}
#' @examples
#' examplefunction('Hello world!')

examplefunction <- function(text){
  return(text)
}