| Title: | Download Overture Maps Data in R |
|---|---|
| Description: | Overture Maps offers free and open geospatial map data sourced from various providers and standardized to a common schema. This tool allows you to download Overture Maps data for a specific region of interest and convert it to several different file formats. For more information, visit <https://overturemaps.org/download/>. |
| Authors: | Dennis Irorere [aut, cre, cph] |
| Maintainer: | Dennis Irorere <[email protected]> |
| License: | MIT + file LICENSE |
| Version: | 0.1.0 |
| Built: | 2025-02-16 09:19:16 UTC |
| Source: | https://github.com/denironyx/overturemapsr |
This function returns the S3 path for the specified Overture dataset schema type.
dataset_path(schema_type, release_date = "2025-01-22")dataset_path(schema_type, release_date = "2025-01-22")
schema_type |
Character. Required. The type of feature to select.
Examples include 'building', 'place', etc. To learn more, run |
release_date |
Character. Optional. The dataset release date (format: 'YYYY-MM-DD'). Defaults to the latest available release. |
Character. The S3 path to the bucket where the data is stored.
# Example usage path <- dataset_path('place', release_date = '2025-01-22') print(path)# Example usage path <- dataset_path('place', release_date = '2025-01-22') print(path)
This function returns all of the overturemaps theme types.
get_all_overture_schema_types()get_all_overture_schema_types()
Character vector. All overturemaps theme types.
The theme types are important for fetching data from the S3 bucket, as they indicate if you are fetching places, buildings, admin, etc.
# Example usage types <- get_all_overture_schema_types() print(types)# Example usage types <- get_all_overture_schema_types() print(types)
This function retrieves metadata information for a given dataset type.
get_dataset_metadata(schema_type, release_date = "2025-01-22")get_dataset_metadata(schema_type, release_date = "2025-01-22")
schema_type |
Character. Required. The type of feature to select. |
release_date |
Character. Optional. The dataset release date (format: 'YYYY-MM-DD'). |
A list containing metadata such as column names and dataset size.
metadata <- get_dataset_metadata('place', release_date = '2025-01-22') print(metadata)metadata <- get_dataset_metadata('place', release_date = '2025-01-22') print(metadata)
This function retrieves a filtered dataset from the specified Overture dataset type,
optionally within a bounding box, and converts it to an sf object.
record_batch_reader(schema_type, bbox = NULL, release_date = "2025-01-22")record_batch_reader(schema_type, bbox = NULL, release_date = "2025-01-22")
schema_type |
Character. Required. The type of feature to select. Examples include 'building', 'place', etc.
To learn more, run |
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. |
An sf object containing the filtered dataset based on the bounding box.
# 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) print(result)# 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) print(result)