R/example_function.R

In mattsq/examplePackage: Me playing with usethis and devtools

#' Example function
#'
#' This is a an example function 
#'
#' It takes two vectors and adds them together.
#' @param x one vector
#' @param y another vector
#' @export
#' @examples
#' x <- 1
#' y <- 1
#' example_function(x = x, y = y)
#' @return
#' This function returns the sum of the two vectors as another vector
#' @author Matt Simmons mattsimmons@email.com
#' @seealso \link[base]{sum}


example_function <-
function(x, y) x + y