lease_event: Define a lease event for the simplified lease-roll API

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

Define a lease event for the simplified lease-roll API

Description

Define a lease event for the simplified lease-roll API

Usage

lease_event(
  start,
  end,
  rent,
  vac = 0,
  free_months = 0,
  capex_sqm = 0,
  new_lease = FALSE
)

Arguments

start	Integer scalar. First calendar year covered by the event.
end	Integer scalar. Last calendar year covered by the event.
rent	Numeric scalar greater than or equal to 0. Headline rent in annual currency per sqm.
vac	Numeric scalar in [0, 1]. Vacancy share for the event.
free_months	Numeric scalar greater than or equal to 0. Rent-free period applied at lease start when new_lease = TRUE.
capex_sqm	Numeric scalar greater than or equal to 0. Capital expenditure per sqm allocated across the event span.
new_lease	Logical or integer scalar. Whether the event corresponds to a new letting.

Value

An object of class cre_lease_event.

Examples

lease_event(start = 2025, end = 2027, rent = 220, vac = 0.05)

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