R/example-documentation.R

In tmsalab/tmsapkg: Your Title Here

#' Sample R function
#'
#' For this function, we...
#'
#' @param x,y `numeric` Data vectors
#'
#' @return A single `numeric` value
#'
#' @author
#' Blame this person
#'
#' @export
#' @examples
#'
#' my_func(1:2, 3:4)
#'
my_func = function(x, y){
    x + y
}