Get BCPS programs and attendance zones for a local area

Usage

get_area_bcps_programs(
  area,
  dist = NULL,
  diag_ratio = NULL,
  asp = NULL,
  crop = TRUE,
  trim = FALSE,
  type = c("all", "zones", "programs", "other")
)

Arguments

area: sf object. If multiple areas are provided, they are unioned into a single sf object using sf::st_union()
dist: buffer distance in meters. Optional.
diag_ratio: ratio to set map extent based diagonal distance of area's bounding box. Ignored when dist is provided.
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.
type: Type of BCPS data to return. "all" returns a named list with all of the following spatial data. "zones" returns attendance zones, "programs" returns locations of programs (schools) with zones intersecting area (even if the program is located outside the area), "other" returns charter schools and other special schools located within the specified area.

Details

Returns a named list with overlapping BCPS attendance zones, program locations associated with those zones, and any additional programs located within the area.