R/loanStep.R

In vkubicki/rfinance: What the package does (short line)

#' Compute evolution of borrowed capital over a month.
#' 
#' @param rate
#' @param transfer
#' @param capital
#' @return 
loanStep <- function(rate,
                     transfer,
                     capital)
{
  interest <- rate * capital
  if (interest > transfer)
  {
    stop("Monthly repay inferior to interest.")
  }
  capPaid <- min(capital,
                 transfer - interest) # test if the current payment is enough to end the capital repay
  # remCap <- capital - capPaid # remaining capital at the end of the period, ie money that can not be invested
  return (list(capPaid = capPaid,
               interest = interest))
}