renewal_event: Define a renewal or reletting event

View source: R/simple_api.R

renewal_eventR Documentation

Define a renewal or reletting event

Description

Define a renewal or reletting event

Usage

renewal_event(start, end, rent, free_months = 0, capex_sqm = 0, vac = 0)

Arguments

start

Integer scalar. First calendar year covered by the renewed or relet lease 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.

free_months

Numeric scalar greater than or equal to 0. Rent-free period applied at the new letting date.

capex_sqm

Numeric scalar greater than or equal to 0. Capital expenditure per sqm allocated across the event span.

vac

Numeric scalar in [0, 1]. Residual vacancy share after the lease starts.

Value

An object of class cre_lease_event.

Examples

renewal_event(start = 2029, end = 2033, rent = 245, free_months = 3)

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