Compare building floor area ratio to zoning requirements

check_far() takes a tidybuilding, tidydistrict, and tidyparcel to see if the district's zoning code allows the tidybuilding based on floor area ratio.

Usage

check_far(
  tidybuilding,
  tidydistrict = NULL,
  tidyparcel_dims,
  zoning_req = NULL
)

Arguments

tidybuilding: A tidybuilding is a list of data frames used to represent a building.
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 side of a parcel and its label (front, Interior side, Exterior side, rear, centroid).
zoning_req: The data frame result from the get_zoning_req() function. If provided, the tidydistrict and parccel need not be provided.

Value

Returns TRUE or FALSE stating whether or not the building would be allowed in the district based on floor area ratio.