R/f_to_c.R

In dhruvrc/STAT302Package: What the Package Does (One Line, Title Case)

#' Farenheit converter
#' 
#' This function converts temperature from Farenheit to Celcius.
#' 
#' @param temp_F Numeric input indicating temperature in Farenheit.
#' @keywords temperature
#' 
#' @return Numeric indicating temperature \code{temp_F} converted to Celcius.
#' 
#' @examples
#' f_to_c(32)
#' f_to_c(212)
#' 
#' @export
f_to_c <- function(temp_F) {
  temp_C <- (temp_F - 32) * 5 / 9
  return(temp_C)
}