R/min_income.R

In aseemdeodhar/mortgager: Obtain various values required in Home Mortgage Calculations

#' Minimum Non-Burdened Income
#'
#' Minimum annual income required for total housing costs to remain at or below 30% of household income:
#'
#' * To be deprecated. Use reqd_income() instead *
#'
#' @param monthlypayment Total Monthly payments towards home-ownership
#'
#' @return Minimum Annual Income required to keep \code{monthlypayment} at or below 30% of income
#' @export
#'
#' @examples
#'
#' min_income(2000)
min_income <- function(monthlypayment){
  output <- (monthlypayment*12)*100/30
  return(output)
}