R/function_template.R

In RachelSilverstein/BioTools: Tools for bio computing

#' Function Template
#'
#' Description of the function
#'
#' A more detailed description of what the function does.
#'
#' @param x A number
#' @param y Another number
#'
#' @return The sum of x and y
#' @export
#'
#' @seealso \code{\link{another_function}} Info
#'
#' @author \href{https://orcid.org/0000-0001-5724-2252}{Rachel Silverstein} (aut)
#'
#' @examples
#' # add 2 and 3
#' example_function(2,3)
#' # [1] 5
#'
#'
example_function <- function (x, y) {
  return(2 + 3)
}