lease_unit: Define one lease unit for the simplified lease-roll API

View source: R/simple_api.R

lease_unitR Documentation

Define one lease unit for the simplified lease-roll API

Description

Define one lease unit for the simplified lease-roll API

Usage

lease_unit(name, area_sqm, events)

Arguments

name

Character scalar. Unit label used in messages and downstream engine structures.

area_sqm

Numeric scalar greater than 0. Lettable area in sqm.

events

List of objects returned by lease_event().

Value

An object of class cre_lease_unit.

Examples

u <- lease_unit(
  "North",
  area_sqm = 1200,
  events = list(lease_event(start = 2025, end = 2027, rent = 220))
)
u$unit

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