dev/functionTemplate.R

In hyginn/rpt: R Package Template

# functionTemplate.R

#' Title.
#'
#' \code{<function>} description.
#'
#' Details.
#' @section <title>: Additional explanation.
#'
#' @param <p> (<type>) <description>.
#' @param <q> (<type>) <description>.
#' @return <description> ... or ...
#' @return NULL (invisible) Invoked for the side effect <describe>.
#'
#' @family <optional description of function family>
#'
#' @author \href{https://orcid.org/<ORCID>}{<author name>} (aut)
#'
#' @seealso \code{\link{<function>}} <describe related function>, ... .
#'
#' @examples
#' # <explain what the example does>
#' myFunction(1i, 1i)
#'
#' @export

myFunction <- function(p, q) {
    # Note

  return(p * q) # or
  return(invisible(NULL))
}

# [END]