get_area_zoning: Get zoning data for an area

View source: R/get_area_zoning.R

get_area_zoningR Documentation

Get zoning data for an area

Description

Get zoning codes for an area within a provided sf or bbox object.

Usage

get_area_zoning(
  area = NULL,
  bbox = NULL,
  category = c("all", "residential", "commercial", "industrial"),
  diag_ratio = NULL,
  dist = NULL,
  asp = NULL,
  crop = TRUE,
  trim = FALSE,
  crs = NULL,
  union = FALSE
)

Arguments

area

sf, sfc, or bbox object. If multiple areas are provided, they are unioned into a single sf object using sf::st_union().

bbox

bbox object defining area used to filter data. If an area is provided, the bounding box is ignored.

category

Zoning category to return. "all", "residential", "commercial", "industrial"

diag_ratio

ratio to set map extent based diagonal distance of area's bounding box. Ignored when dist is provided.

dist

buffer distance in meters. Optional.

asp

Aspect ratio of width to height as a numeric value (e.g. 0.33) or character (e.g. "1:3").

crop

If TRUE, data cropped to area or bounding box sf::st_crop() adjusted by the dist, diag_ratio, and asp parameters provided. Default TRUE.

trim

If TRUE, data trimmed to area with sf::st_intersection(). This option is not supported for any adjusted areas that use the dist, diag_ratio, or asp parameters. Default FALSE.

crs

Coordinate Reference System (CRS) to use for the returned data. The CRS of the provided data and bounding box or area must match one another but are not required to match the CRS provided by this parameter.

union

Logical. Default FALSE. If true, group zoning by label and combine geometry with sf::st_union().

Details

This 2017 zoning data does not include any exemptions granted by the Baltimore City BMZA (Board of Municipal Zoning Appeals).

Value

sf object with zoning and overlay data for area.


elipousson/mapbaltimore documentation built on April 2, 2024, 4:23 p.m.