Do total building units meet zoning requirements

check_unit_qty compares the total units in a tidybuilding object to the allowable number of units according to the tidyzoning data and returns TRUE, FALSE, or MAYBE

Usage

check_unit_qty(
  tidybuilding = NULL,
  tidydistrict = NULL,
  tidyparcel_dims = NULL,
  building_json,
  zoning_req = NULL
)

Arguments

tidybuilding

A dataframe with fields to represent a building. Created from the function unify_tidybuilding.

tidydistrict

The tidydistrict corresponding to the tidyparcel. A tidydistrict object is one row from a tidyzoning simple features object.

tidyparcel_dims

A tidyparcel object is an simple features object depicting each parcel and its its dimentions.

building_json

The file path or json string of the json representing the building.

zoning_req

The data frame result from the get_zoning_req() function. If provided, the tidydistrict and parccel need not be provided.