doc/documentation_template.R

In geneorama/geneorama: Gene's collection of miscellaneous functions

#' @name 
#' @title 
#' @author Gene Leynes
#'
#' @param param1   description of param1...
#' @param param2   description of param2...
#'
#' @description
#' 		A function that ...
#'
#' @details
#' 		some details are...
#'
#' @note
#' 		Assumes blah blah blah
#'
#' @source
#' 		\url{http://en.wikipedia.org/wiki/Black-Scholes_model}
#' 		
#' @seealso
#' 	\code{\link{bgfun}},
#' 	\code{\link{plot100colors}} to see color examples
#' 	\code{\link[ggplot2]{ggplot}} Way better
#' @examples
#'		
#'
#'
#'