get_area_permits: Get area building permits from Open Baltimore

View source: R/get_area_permits.R

get_area_permitsR Documentation

Get area building permits from Open Baltimore

Description

Get building permits from 2019 through the present.

Usage

get_area_permits(
  area,
  year = 2022,
  date_range = NULL,
  permit_type = NULL,
  where = NULL,
  dist = NULL,
  diag_ratio = NULL,
  unit = "m",
  asp = NULL,
  trim = FALSE,
  crs = pkgconfig::get_config("mapbaltimore.crs", 2804),
  ...
)

Arguments

area

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

year

Year. Must be 2019 or later.

date_range

Date range as character vector in format of c("YYYY-MM-DD", "YYYY-MM-DD"). Minimum and maximum values are used if length is greater than 1.

permit_type

Optional. Supported values include "USE", "DEM", "COM", or "BMZ".

where

string for where condition. permit_type and year are ignored if a custom where is provided. Set where to "1=1" to return data for all years since 2019.

dist

buffer distance in units. Optional.

diag_ratio

ratio of diagonal distance of area's bounding box used as buffer distance. e.g. if the diagonal distance is 3000 meters and the "diag_ratio = 0.1" a 300 meter will be used. Ignored when dist is provided.

unit

Units for buffer. Supported options include "meter", "foot", "kilometer", and "mile", "nautical mile" Common abbreviations (e.g. "km" instead of "kilometer") are also supported. Distance in units is converted to units matching GDAL units for x; defaults to "meter"

asp

Aspect ratio of width to height as a numeric value (e.g. 0.33) or character (e.g. "1:3"). If numeric, get_asp() returns the same value without modification.

trim

If TRUE, x is trimmed to y with st_trim().

crs

Cordinate reference system to return, Default: 4326 for sf_to_df() and NULL for df_to_sf().

...

Additional parameters passed to getdata::get_esri_data().


elipousson/mapbaltimore documentation built on Dec. 1, 2024, 1:22 p.m.