R/Template_function.R

In flogrc/piflow: Precipitation and discharge analysis tools with zoo vector

#'Short resume of function (max 10 words)
#'
#'Explain the function
#'
#'@param  name [class] of the parameter 1 and details
#'@param  name [class] of the parameter 2 and details
#'
#'@return \emph{output 1} [class] : explanation [unit]
#'@return \emph{output 2} [class] : explanation [unit]
#'
#'@author Florine Garcia (florine.garcia@gmail.com)
#'@author Pierre L'Hermite (pierrelhermite@yahoo.fr)
#'
#'@examples
#'How to use function
#'
#'@references
#'
#'@details
#'
#'@seealso
#'\code{\link[package name]{function name}}

function_name <- function(data) {
}