dev/functionTemplate.R

In zyhbetty/BCB420.2019.encode: R Package for Encode

# functionTemplate.R

#' Title.
#'
#' \code{<function>} description.
#'
#' Details.
#' @section <title>: Additional explanation.
#'
#' @param <p> <description>.
#' @param <q> <description>.
#' @return <description>.
#'
#' @family <optional description of family>
#'
#' @author \href{https://orcid.org/0000-0002-1134-6758}{Boris Steipe} (aut)
#'
#' @seealso \code{\link{<function>}} <describe related function>, ... .
#'
#' @examples
#' # <explain what the example does>
#' myFunction(1i, 1i)
#'
#' @export

myFunction <- function(p, q) {

    return(p * q)
}

# [END]