inst/scripts/functionTemplate.R

In hyginn/shi: Multiple Sequence Alignment Handling and Inspection

# functionTemplate.R

#' Title.
#'
#' \code{<function>} description.
#'
#' Details.
#' @section <title>: Additional explanation.
#'
#' @param <p> <description>.
#' @param <q> <description>.
#' @return <description>.
#'
#' @family <optional description of family>
#'
#' @seealso \code{\link{<function>}} <describe related function>, ... .
#'
#' @examples
#' multiply(1, 1)
#' multiply(1i, 1i)
#' multiply(13, 3)
functionName <- function(p, q) {

    return(value)
}

# [END]