R/f.R

Defines functions g f

Documented in f g

#' @title A function f
#'
#' This function adds one to a value
#' @param x This is the value one is added to. Defaults to 7.
#' @keywords add
#' @export
#' @examples
#' f(-1) = 0, f() = 8

f <- function(x = 7){

  print(x+1)


}

#' @title A function g
#'
#' This function multiplies two values
#' @param x This is one factor. Default is 5.
#' @param y This is another factor. Default is 10.
#' @keywords multiply
#' @export
#' @examples
#' g() = 50. g(3,6) = 18

g <- function(x = 5, y = 10){

  print(x * y)

}
robertglegg/test documentation built on May 25, 2017, 5:20 a.m.