Title:	Load 'Overture' Datasets as 'dbplyr' and 'sf'-Ready Data Frames
Version:	0.2.5
Description:	An integrated R interface to the 'Overture' API (https://docs.overturemaps.org/). Allows R users to return 'Overture' data as 'dbplyr' data frames or materialized 'sf' spatial data frames.
License:	MIT + file LICENSE
Suggests:	bench, duckdbfs, ggplot2, httr, jsonlite, knitr, rmarkdown, spelling, testthat (≥ 3.0.0)
Config/testthat/edition:	3
Encoding:	UTF-8
RoxygenNote:	7.3.2
URL:	https://github.com/arthurgailes/overtureR, https://arthurgailes.github.io/overtureR/
BugReports:	https://github.com/arthurgailes/overtureR/issues
Imports:	DBI, dbplyr, dplyr (≥ 1.0.0), duckdb (≥ 1.0.0), glue, rlang, sf
VignetteBuilder:	knitr
NeedsCompilation:	no
Packaged:	2025-04-18 19:07:31 UTC; Arthur.Gailes
Author:	Arthur Gailes [aut, cre, cph]
Maintainer:	Arthur Gailes <agailes1@gmail.com>
Repository:	CRAN
Date/Publication:	2025-04-21 14:00:02 UTC

Convert a tbl_sql object to a overture_call object

Description

This function adds the overture_call class to a tbl_sql object. It is primarily used internally#' by the open_curtain() function but can also be used directly on tbl_sql #' objects representing Overture Maps data.

Usage

as_overture(x, type, theme = get_theme_from_type(type))

Arguments

Details

The function adds the overture_call class as the first class of the object

Value

A tbl_sql object with the additional class overture_call and attributes overture_type and overture_theme.

Examples

# The open_curtain() function already uses as_overture() internally,
# but you can also use it directly:
conn <- stage_conn()
division <- open_curtain("division", tablename = "test")

class(division)

# views
division2 <- tbl(conn, "test")
division2 <- as_overture(division2)

exit_stage(conn)

Convert dbplyr table to sf Object

Description

Collects a lazy dbplyr view and materializes it as an in-memory sf table. collect_sf is a deprecated alias.

Usage

## S3 method for class 'overture_call'
collect(x, ..., geom_col = "geometry", crs = 4326)

collect_sf(...)

Arguments

Value

An 'sf' object with the dataset converted to spatial features.

Examples

bbox <- c(xmin = -120.5, ymin = 35.5, xmax = -120.0, ymax = 36.0)
lazy_tbl <- open_curtain("building", bbox)
collect(lazy_tbl)

Check duckdb extension and config settings

Description

Check duckdb extension and config settings

Usage

config_extensions(conn)

Arguments

Retrieve (Spatially Filtered) Overture Datasets

Description

Fetches overture data from AWS. If a bounding box is provided, it applies spatial filtering to only include records within that area. The core code is copied from duckdbfs, which deserves all credit for the implementation

Usage

open_curtain(
  type,
  spatial_filter = NULL,
  theme = get_theme_from_type(type),
  conn = NULL,
  as_sf = FALSE,
  mode = "view",
  tablename = NULL,
  read_opts = list(),
  base_url = "s3://overturemaps-us-west-2/release/2025-03-19.0",
  bbox = NULL
)

Arguments

Value

An dbplyr lazy dataframe, or an sf dataframe if as_sf is TRUE

Examples

bbox <- c(xmin = -120.5, ymin = 35.5, xmax = -120.0, ymax = 36.0)
open_curtain("building", bbox)

Download Overture Maps Data to Local Directory

Description

This function downloads Overture Maps data to a local directory, maintaining the same partition structure as in S3. snapshot_overture defaults 'output_dir' to tempdir() and overwrite to TRUE.

Usage

record_overture(curtain_call, output_dir, overwrite = FALSE, write_opts = NULL)

snapshot_overture(
  curtain_call,
  output_dir = tempdir(),
  overwrite = TRUE,
  write_opts = NULL
)

Arguments

Value

Another tbl_lazy. Use dplyr::show_query() to see the generated query, and use dplyr::collect() to execute the query and return data to R.

An 'overture_call' for the downloaded data

See Also

DuckDB documentation on partitioned writes

Examples

broadway <- c(xmin = -73.99, ymin = 40.76, xmax = -73.98, ymax = 40.76)
buildings <- open_curtain("building", spatial_filter = bbox)
local_buildings <- record_overture(buildings, tempdir(), overwrite = TRUE)

Registeran sf object as a DuckDB virtual table

Description

A thin wrapper around duckdb::duckdb_register() that creates a virtual table, then selects the geometry column to DuckDB.'s GEOMETRY type in the returned dbplyr representation. Mostly useful for join and spatial operations within DuckDB. No data is copied.

Usage

sf_as_dbplyr(
  conn,
  name,
  sf_obj,
  geom_only = isFALSE(inherits(sf_obj, "sf")),
  overwrite = FALSE,
  ...
)

Arguments

Details

Behind the scenes, this function creates an initial view (name_init) with the geometry stored as text via sf::st_as_text. It then creates the view name which replaces the geometry column with DuckDB's internal geometry type.

Value

a dbplyr lazy table

Examples

library(sf)

con <- stage_conn()
sf_obj <- st_sf(a = 3, geometry = st_sfc(st_point(1:2)))
sf_as_dbplyr(con, "test", sf_obj)

DBI::dbDisconnect(con)

create a cachable duckdb connection. In dev

Description

stage_conn is primarily intended for internal use by other overtureR functions. However, it can be called directly by the user whenever it is desirable to have direct access to the connection object. The core code is copied from duckdbfs, which deserves all credit for the implementation

Usage

stage_conn(
  dbdir = ":memory:",
  read_only = FALSE,
  bigint = "numeric",
  config = list(),
  ...
)

strike_stage(conn = stage_conn())

Arguments

Details

When first called (by a user or internal function), this function both creates a duckdb connection and places that connection into a cache (overturer_conn option). On subsequent calls, this function returns the cached connection, rather than recreating a fresh connection.

This frees the user from the responsibility of managing a connection object, because functions needing access to the connection can use this to create or access the existing connection. At the close of the global environment, this function's finalizer should gracefully shutdown the connection before removing the cache.

strike_stage closes the connection.

Value

a duckdb::duckdb()connection object

Examples

con <- stage_conn()
strike_stage(con)