Package 'overturemapsr'

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.0.4
Built: 2024-11-09 04:52:54 UTC
Source: https://github.com/denironyx/overturemapsr

Help Index


dataset_path

Description

This function returns the S3 path for the specified Overture dataset type.

Usage

dataset_path(overture_type)

Arguments

overture_type

Character. Required. The type of feature to select. Examples include 'building', 'place', etc. To learn more, run get_all_overture_types().

Value

Character. The S3 path to the bucket where the data is stored.

Examples

# Example usage
path <- dataset_path('place')
print(path)

get_all_overture_types

Description

This function returns all of the overturemaps theme types.

Usage

get_all_overture_types()

Value

Character vector. All overturemaps theme types.

Note

The theme types are important for fetching data from the S3 bucket, as they indicate if you are fetching places, buildings, admin, etc.

Examples

# Example usage
types <- get_all_overture_types()
print(types)

record_batch_reader

Description

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(overture_type, bbox = NULL)

Arguments

overture_type

Character. Required. The type of feature to select. Examples include 'building', 'place', etc. To learn more, run get_all_overture_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.

Value

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

Examples

# Example usage with a bounding box takes > 20 secs
sf_bbox <- c(-122.5, 37.7, -122.3, 37.8)
result <- record_batch_reader(overture_type = 'place', bbox = sf_bbox)
print(result)