#' One line description
#'
#' @description
#' More detailed, multi-line
#' description.
#'
#' @param example1 some parameter of the function
#' @param example2 some other parameter of the function
#'
#' @return what the function does return
#'
#' @export nameOfTheFunction
#'
#' @examples
#' not run:
#' nameOfTheFunction(example1= "X", example2 = 5)
nameOfTheFunction <- function(...){...}