R/effective_annual_rate.R

Defines functions effective_annual_rate

Documented in effective_annual_rate

#' Calculate the effective annual rate (EAR) of interest
#'
#' @param rate Interest rate per period
#' @param m Number of periods in a year
#' @return Effective annual rate
#' @examples
#' effective_annual_rate(.10, 2)
#' @export
effective_annual_rate <- function(rate, m) {

    ear <- (1 + rate / m) ^ m - 1

    return(ear)
}
bclark86/clarklytics documentation built on Oct. 4, 2020, 12:14 a.m.