debt_terms: Define simple debt terms for a CRE deal

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

Define simple debt terms for a CRE deal

Description

Builds a compact financing specification intended for the simplified R API. Use this helper together with deal_spec() and analyze_deal() instead of manipulating the full YAML-like configuration directly.

Usage

debt_terms(
  ltv = 0.55,
  rate = 0.045,
  type = c("bullet", "amort"),
  maturity = NULL,
  extra_amort_pct = 0,
  arrangement_fee_pct = 0,
  capitalized_fees = FALSE
)

Arguments

ltv	Numeric scalar in [0, 1]. Initial loan-to-value ratio.
rate	Numeric scalar in [0, 1]. Annual nominal interest rate.
type	Character scalar. Either "bullet" or "amort".
maturity	Optional integer scalar greater than or equal to 1. When NULL, the deal horizon is used.
extra_amort_pct	Numeric scalar in [0, 1]. Additional annual amortisation share used for bullet structures.
arrangement_fee_pct	Numeric scalar in [0, 1]. Arrangement fee applied to the initial principal.
capitalized_fees	Logical scalar. Whether arrangement fees are capitalized into the initial draw.

Value

An object of class cre_debt_terms.

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