deal_spec: Define a simplified CRE deal specification
In cre.dcf: Discounted Cash Flow Tools for Commercial Real Estate

deal_spec

R Documentation

Define a simplified CRE deal specification

Description

Builds a beginner-friendly deal object that can be analyzed with analyze_deal(). Exactly one income mode must be provided:

entry_yield,
noi_y1,
rent_sqm + area_sqm,
lease_roll.

Usage

deal_spec(
  price,
  horizon_years = 10L,
  entry_yield = NULL,
  noi_y1 = NULL,
  rent_sqm = NULL,
  area_sqm = NULL,
  lease_roll = NULL,
  vacancy_rate = 0,
  opex_sqm = 0,
  purchase_year = as.integer(format(Sys.Date(), "%Y")),
  index_rate = 0.02,
  acq_cost_rate = 0.06,
  discount_rate = 0.08,
  capex = 0,
  exit_yield_spread_bps = 0,
  exit_cost = 0.015,
  debt = debt_terms()
)

Arguments

`price`	Numeric scalar greater than 0. All-in acquisition price (`price_di`) used by the simplified API.
`horizon_years`	Integer scalar greater than or equal to 1.
`entry_yield`	Optional numeric scalar in `(0, 1]`. Entry yield for the top-down mode.
`noi_y1`	Optional numeric scalar greater than 0. Year-1 NOI.
`rent_sqm`	Optional numeric scalar greater than or equal to 0. Annual rent per sqm.
`area_sqm`	Optional numeric scalar greater than 0. Lettable area in sqm.
`lease_roll`	Optional object returned by `lease_roll()`. Use this mode to describe several units and lease events without writing YAML manually.
`vacancy_rate`	Numeric scalar in `[0, 1)`. Used only in the rent/surface mode.
`opex_sqm`	Numeric scalar greater than or equal to 0. Used only in the rent/surface and lease-roll modes.
`purchase_year`	Integer scalar. Defaults to the current year.
`index_rate`	Numeric scalar in `[0, 1]`. Annual growth/indexation.
`acq_cost_rate`	Numeric scalar in `[0, 1)`. Acquisition cost rate.
`discount_rate`	Numeric scalar in `[0, 1]`. Discount rate mapped to the `"risk_premium"` engine block.
`capex`	Numeric scalar or numeric vector of length `horizon_years`.
`exit_yield_spread_bps`	Numeric scalar. Exit-yield spread in basis points.
`exit_cost`	Numeric scalar in `[0, 1)`. Exit cost rate.
`debt`	Object returned by `debt_terms()`.