summarize_case: Summarise a financing scenario from ratios and metrics

In cre.dcf: Discounted Cash Flow Tools for Commercial Real Estate

Summarise a financing scenario from ratios and metrics

Description

Builds a one-line summary for a given scenario using:

• levered / unlevered metrics (IRR / NPV);

• credit ratios computed by add_credit_ratios().

Usage

summarize_case(tag, lev_obj, rat_tbl, maturity)

Arguments

tag	Character(1). Scenario name ("all_equity", "debt_bullet", "debt_amort", ...).
lev_obj	List. Metrics object (contains irr_equity, npv_equity, irr_project, npv_project).
rat_tbl	data.frame. Ratios table (contains year, dscr, ltv_forward).
maturity	Integer(1). Maturity year (must correspond to horizon_years).

Details

Canonical rules (maturity = horizon_years)

Maturity is now strictly equal to the investment horizon, without implicit fallbacks such as min(N, 5).

As a consequence:

• min DSCR takes the value of the attribute min_dscr_pre_maturity if available (set by add_credit_ratios(ignore_balloon_in_min = TRUE)).

• Otherwise, min DSCR is the minimum over years 1 ... maturity-1 (all operational years before the balloon repayment).

• max forward LTV is the maximum over years 1 ... maturity, always explicitly excluding t = 0.

Value

Tibble with columns: scenario, irr_equity, npv_equity, irr_project, npv_project, min_dscr, max_ltv_forward, ops_share, tv_share.

cre.dcf documentation built on April 10, 2026, 5:08 p.m.