R/burd_income.R

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

#' Burdened Income
#'
#' Minimum annual income required for total housing costs to remain at or below 50% 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 50% of income
#' @export
#'
#' @examples
#'
#' burd_income(2000)
burd_income <- function(monthlypayment){
  output <- (monthlypayment*12)*100/50
  return(output)
}