R/basic_functions.R

In nclJoshCowley/nclCowley: Trivial Package to Learn Package Creation

## ------------------------------------------------------------------------
## Josh Cowley. Last modified 31-10-19
## Wrtie some very basic functions to show proof of concept
## ------------------------------------------------------------------------

#' Multiply numeric by 23
#'
#' \code{MultiplyBy23()} multiplies the given arugment by 23.
#'
#' @param t Numeric argument.
#' @return The value of 23 * \code{t}
#' @export
#'
#' @examples
#' MultiplyBy23(1)
#' MultiplyBy23(c(1,3,5))
#'
#' \dontrun{
#' MultiplyBy23("a") # Nonsensical
#' }
MultiplyBy23 <- function(t) {
  temp <- t * 23
  return(temp)
}