lease_roll: Group lease units into a simplified lease roll

View source: R/simple_api.R

lease_rollR Documentation

Group lease units into a simplified lease roll

Description

Group lease units into a simplified lease roll

Usage

lease_roll(units)

Arguments

units

List of objects returned by lease_unit().

Value

An object of class cre_lease_roll.

Examples

roll <- lease_roll(list(
  lease_unit(
    "North",
    area_sqm = 1200,
    events = list(lease_event(start = 2025, end = 2027, rent = 220))
  )
))
length(roll$units)

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