R/cookie_test.R

Defines functions add

#' testing out the cookie cutter project
#'
#' @docType package
#' @name cookie_test
NULL

#
# Write functions only and document them with roxygen-styled comments.
# Example below taken from http://r-pkgs.had.co.nz/man.html
#

#' Add together two numbers.
#' 
#' @param x A number.
#' @param y A number.
#' @return The sum of \code{x} and \code{y}.
#' @examples
#' add(1, 1)
#' add(10, 1)
#' @export
add <- function(x, y) {
      x + y
}
add(2,3)
bbc/cookie_test documentation built on Dec. 19, 2021, 6:46 a.m.