ddbs_xy: Extract coordinates from geometries

In duckspatial: R Interface to 'DuckDB' Database with Spatial Extension

Extract coordinates from geometries

Description

Extracts the X, Y, M, or Z coordinates from POINT geometries

Usage

ddbs_x(
  x,
  new_column = "X",
  conn = NULL,
  name = NULL,
  mode = NULL,
  overwrite = FALSE,
  quiet = FALSE
)

ddbs_y(
  x,
  new_column = "Y",
  conn = NULL,
  name = NULL,
  mode = NULL,
  overwrite = FALSE,
  quiet = FALSE
)

ddbs_m(
  x,
  new_column = "M",
  conn = NULL,
  name = NULL,
  mode = NULL,
  overwrite = FALSE,
  quiet = FALSE
)

ddbs_z(
  x,
  new_column = "Z",
  conn = NULL,
  name = NULL,
  mode = NULL,
  overwrite = FALSE,
  quiet = FALSE
)

Arguments

x	Input spatial data. Can be: A duckspatial_df object (lazy spatial data frame via dbplyr) An sf object A tbl_lazy from dbplyr A character string naming a table/view in conn Data is returned from this object.
new_column	Name of the new column to store the extracted coordinate. Defaults to "X", "Y", "M", or "Z".
conn	A connection object to a DuckDB database. If NULL, the function runs on a temporary DuckDB database.
name	A character string of length one specifying the name of the table, or a character string of length two specifying the schema and table names. If NULL (the default), the function returns the result as an sf object
mode	Character. Controls the return type. Options: "duckspatial" (default): Lazy spatial data frame backed by dbplyr/DuckDB "sf": Eagerly collected sf object (uses memory) Can be set globally via ddbs_options(mode = "...") or per-function via this argument. Per-function overrides global setting.
overwrite	Boolean. whether to overwrite the existing table if it exists. Defaults to FALSE. This argument is ignored when name is NULL.
quiet	A logical value. If TRUE, suppresses any informational messages. Defaults to FALSE.

Details

• ddbs_x(): Extracts the X coordinate (longitude).

• ddbs_y(): Extracts the Y coordinate (latitude).

• ddbs_m(): Extracts the M coordinate (measure).

• ddbs_z(): Extracts the Z coordinate (elevation).

Value

Depends on the mode argument (or global preference set by ddbs_options):

• duckspatial (default): A duckspatial_df (lazy spatial data frame) backed by dbplyr/DuckDB.

• sf: An eagerly collected object in R memory, that will return the same data type as the sf equivalent (e.g. sf or units vector).

When name is provided, the result is also written as a table or view in DuckDB and the function returns TRUE (invisibly).

Examples

## Not run: 
## load package
library(duckspatial)

## read data
argentina_ddbs <- ddbs_open_dataset(
  system.file("spatial/argentina.geojson",
  package = "duckspatial")
)

## extract coordinates
ddbs_x(argentina_ddbs)
ddbs_y(argentina_ddbs)

## End(Not run)

duckspatial documentation built on June 22, 2026, 9:08 a.m.