R/plot_future_income.R

In R4GoodPersonalFinances: Make Optimal Financial Decisions

#' Plot future income structure over household life cycle
#' 
#' @inheritParams plot_expected_capital
#' @inheritParams plot_scenarios
#' @param y_limits A numeric vector of two values. Y-axis limits.
#' @returns A [ggplot2::ggplot()] object.
#' @examplesIf interactive()
#' older_member <- HouseholdMember$new(
#'   name       = "older",  
#'   birth_date = "1980-02-15",
#'   mode       = 80,
#'   dispersion = 10
#' )  
#' household <- Household$new()
#' household$add_member(older_member)  
#' 
#' household$expected_income <- list(
#'   "income" = c(
#'     "members$older$age <= 65 ~ 7000 * 12",
#'     "members$older$age > 65 ~ 3000 * 12"
#'   )
#' )
#' household$expected_spending <- list(
#'   "spending" = c(
#'     "TRUE ~ 5000 * 12"
#'   )
#' )
#' 
#' portfolio <- create_portfolio_template() 
#' portfolio$accounts$taxable <- c(10000, 30000)
#' portfolio <- 
#'   portfolio |> 
#'   calc_effective_tax_rate(
#'     tax_rate_ltcg = 0.20, 
#'     tax_rate_ordinary_income = 0.40
#'   )
#' 
#' scenario <- 
#'   simulate_scenario(
#'    household = household,
#'    portfolio = portfolio,
#'    current_date = "2020-07-15"
#'   )
#' 
#' plot_future_income(scenario, "monthly")
#' @export
plot_future_income <- function(
  scenario,
  period   = c("yearly", "monthly"),
  y_limits = c(NA, NA)
) {

  period <- rlang::arg_match(period)

  return(
    plot_structure(
      scenario, 
      structure_of = "income",
      period       = period,
      y_limits     = y_limits
    )
  )
}