record_batch_reader — record_batch_reader • overturemapsr

This function retrieves a filtered dataset from the specified Overture dataset type, optionally within a bounding box, and converts it to an sf object.

Usage

record_batch_reader(schema_type, bbox = NULL, release_date = "2025-01-22")

Arguments

schema_type: Character. Required. The type of feature to select. Examples include 'building', 'place', etc. To learn more, run get_all_overture_schema_types().
bbox: Numeric vector. Optional. A bounding box specified as c(xmin, ymin, xmax, ymax). It is recommended to use a bounding box to limit the dataset size and processing time. Without a bounding box, processing the entire dataset (e.g., buildings over 2 billion) can be time-consuming.
release_date: Character. Optional. The dataset release date (format: 'YYYY-MM-DD'). Defaults to the latest available release.

Value

An sf object containing the filtered dataset based on the bounding box.

Examples

# \donttest{
# Example usage with a bounding box takes > 20 secs
sf_bbox <- c(-122.5, 37.7, -122.3, 37.8)
result <- record_batch_reader(schema_type = 'place', bbox = sf_bbox)
#> Error in record_batch_reader(schema_type = "place", bbox = sf_bbox): unused argument (schema_type = "place")
print(result)
#> Error in eval(expr, envir, enclos): object 'result' not found
# }