inst/PackageInitiation/Roxygen/aFunction.R

In pjnewcombe/Pmisc: A collection of miscellaneous functions.

#' Multiplies two numbers and returns the result
#' @export
#' @title Multiplies two numbers and returns the result
#' @name aFunction
#' @param a A number I want to multiply by something
#' @param b A multiplying constant
#' @return A number - the product of a and b
#' @author Paul Newcombe
aFunction <- function(a, b) {
  results <- a*b
  return(out)
}