Help for package dbSpatial

Title:

Spatial Data Operations for Database-Backed Geometries

Version:

0.1.1

Description:

Provides database-backed spatial geometry classes and methods for working with vector spatial data in 'DuckDB'. The package supports loading, converting, querying, joining, and measuring spatial geometries through familiar 'sf'-style interfaces while keeping geometry columns lazy inside the database. It integrates with 'dbProject' to preserve database paths, live connections, and spatial table metadata across interactive sessions. The package follows the Simple Features framework described by Pebesma (2018) <doi:10.32614/RJ-2018-009> and uses DuckDB's spatial extension https://duckdb.org/docs/stable/core_extensions/spatial/overview.html.

License:

GPL-3 | MIT + file LICENSE

Encoding:

UTF-8

RoxygenNote:

7.3.3

Depends:

R (≥ 4.1.0)

Imports:

methods, tools, DBI, duckdb (≥ 1.4.0), dplyr, dbplyr, terra, sf, e1071, lifecycle, crayon, checkmate, cli, rlang, glue, tidyselect, dbProject

Suggests:

knitr, rmarkdown, testthat (≥ 3.0.0)

VignetteBuilder:

knitr

URL:

https://github.com/dbverse-org/dbspatial-r, https://dbverse-org.github.io/dbspatial-r/

BugReports:

https://github.com/dbverse-org/dbspatial-r/issues

Config/testthat/edition:

Collate:

'utils.R' 'generics.R' 'classes.R' 'accessors.R' 'as_dbSpatial.R' 'coerce.R' 'constructors.R' 'dbSpatial.R' 'extract.R' 'geometry_ops.R' 'global.R' 'imports.R' 'input_validation.R' 'loadSpatial.R' 'measurements.R' 'show.R' 'sim_dbSpatial.R' 'sql_gen.R' 'st_as_sf.R' 'st_bbox.R' 'st_geometry_type.R' 'st_geometrytype.R' 'st_is_valid.R' 'st_spatial_join.R' 'st_join.R' 'st_read.R' 'st_translate.R' 'st_xmax.R' 'st_ymax.R' 'vect.R'

NeedsCompilation:

Packaged:

2026-05-20 12:22:23 UTC; ecruiz

Author:

Edward C. Ruiz

[aut, cre], Jiaji George Chen [aut], Ruben Dries [aut, rev]

Maintainer:

Edward C. Ruiz <ecr7407@gmail.com>

Repository:

CRAN

Date/Publication:

2026-05-27 19:40:07 UTC

Column extraction for dbSpatial

Description

Extract a column from a dbSpatial object

Usage

## S4 method for signature 'dbSpatial'
x$name

Arguments

x

A dbSpatial object

name

Column name to extract

Value

A vector of values from the specified column

Simulate basic dbSpatial object

Description

Simulate basic dbSpatial object

Usage

.sim_dbSpatial(geom = c("point", "polygon"))

Arguments

geom

whether to load 'point' or 'polygon' GEOMETRY test file

Details

Polygon data is created dynamically using sf rather than loading from inst/extdata/polygon.geojson. This avoids issues with system.file() returning an empty string when called from dependent packages during R CMD check (before dbSpatial is fully installed to the test library).

Value

A dbSpatial object

Ingest spatial data from a file as a `VIEW` and create a `dbSpatial` object

Description

Ingest spatial data from a file as a VIEW and create a dbSpatial object

Usage

.st_read(
  conn,
  name,
  value,
  x_colName = NULL,
  y_colName = NULL,
  geomName = "geom",
  overwrite = FALSE,
  return = TRUE,
  ...
)

Arguments

conn

a duckdb connection

name

name of the table to be created

value

a data.frame or a file path

x_colName

name of the column containing x coordinates. default: 'NULL'

y_colName

name of the column containing y coordinates. default: 'NULL'

geomName

name of the geometry column to be created. default: 'geom'

overwrite

logical; if TRUE, overwrite the table if it already exists default: 'FALSE'

return

return dbSpatial object. default: 'FALSE'

...

additional arguments to pass to st_read

Details

For list of files supported see the documentation below. https://DuckDB.org/docs/extensions/spatial.html#st_read—read-spatial-value-from-files

Value

dbSpatial object if return = TRUE else NULL

Base function for spatial joins

Description

Internal base function for spatial joins.

Usage

.st_spatial_join(
  g1,
  g1_geomName = "geom",
  g1_cols_keep = "all",
  g2,
  g2_geomName = "geom",
  g2_cols_keep = "all",
  overwrite = FALSE,
  name,
  st_name,
  extra_args = NULL,
  ...
)

Arguments

g1

A dbSpatial object.

g1_geomName

character. The geometry column name in g1. Default: "geom".

g1_cols_keep

character vector. The column names in g1 to keep. Default: "all".

g2

A dbSpatial object.

g2_geomName

character. The geometry column name in g2. Default: "geom".

g2_cols_keep

character vector. The column names in g2 to keep. Default: "all".

overwrite

logical. If TRUE, overwrite existing table. Default: FALSE.

name

character. The name of the output table.

st_name

character. The name of the spatial join function to use.

...

Additional arguments passed to duckdb::dbSendQuery().

Details

Returns a VIEW of the spatial join. Must compute to save results.

Value

dbSpatial object

Convert an sf or terra object to a `dbSpatial` object

Description

Create a dbSpatial object from an sf or terra object.

Usage

as_dbSpatial(rSpatial, conn, name, overwrite = FALSE, ...)

Arguments

rSpatial

sf or terra object.

conn

A DBI connection object, as returned by DBI::dbConnect().

name

a character string with the unquoted DBMS table name, e.g. "table_name"

overwrite

logical. Overwrite existing table. default = FALSE.

...

Additional arguments to be passed

Details

Writes the rSpatial object to a temporary DuckDB table and computes the table in the database with the specified name and the geometry column as geom.

Value

A dbSpatial object backed by table name in conn, with the geometry column stored as geom.

Examples

if (interactive() && requireNamespace("duckdb", quietly = TRUE)) {
  coordinates <- data.frame(x = c(100, 200, 300), y = c(500, 600, 700))
  attributes <- data.frame(id = 1:3, name = c("A", "B", "C"))

  # Combine the coordinates and attributes
  dummy_data <- cbind(coordinates, attributes)

  # Create a SpatVector from the data.frame
  dummy_spatvector <- terra::vect(dummy_data, geom = c("x", "y"))

  # Set db connection
  duckdb_conn = DBI::dbConnect(duckdb::duckdb(), ":memory:")
  DBI::dbExecute(duckdb_conn, "SET threads = 1")

  dbSpatial <- as_dbSpatial(rSpatial = dummy_spatvector,
                           conn = duckdb_conn,
                           name = "dummy_spatvector",
                           overwrite = TRUE)
  dbSpatial
  DBI::dbDisconnect(duckdb_conn, shutdown = TRUE)
}

Create a `dbSpatial` object with geometry data type

Description

Constructor function to ingest diverse spatial data sources and create a dbSpatial object containing a geometry data type based on the Simple Features standard.

If x_colName and y_colName are both provided, a POINT geometry will be constructed based on these columns.

Usage

dbSpatial(
  value,
  name,
  conn,
  x_colName = NULL,
  y_colName = NULL,
  geomName = "geom",
  overwrite = FALSE,
  ...
)

Arguments

value

data.frame, tbl_duckdb_connection, character (valid file path), sf object, or terra object. Data to construct dbSpatial object with geometry data type. See details for more information.

name

Table name.

conn

A DBI connection object.

x_colName

character. Name of column containing numerical X coordinates. default = NULL.

y_colName

character. Name of column containing numerical Y coordinates. default = NULL.

geomName

character string. The geometry column name in the dbSpatial object. Default: "geom".

overwrite

logical. Overwrite existing table. default = FALSE.

...

Additional arguments to be passed

Details

For list of files supported see link below. https://DuckDB.org/docs/extensions/spatial.html#st_read—read-spatial-value-from-files

Value

dbSpatial object.

Examples

if (interactive() && requireNamespace("duckdb", quietly = TRUE)) {
  # create in-memory DuckDB db
  duckdb_conn = DBI::dbConnect(duckdb::duckdb(), ":memory:")
  DBI::dbExecute(duckdb_conn, "SET threads = 1")

  # test value
  test_data = data.frame(x = 1:10, y = 1:10, id = 1:10)

  test_file <- tempfile(fileext = ".csv")
  write.csv(test_data, test_file, row.names = FALSE)

  # read data.frame and create point geometry
  dbSpatial(conn = duckdb_conn,
            name = "test_points",
            value = test_data,
            x_colName = "x",
            y_colName = "y",
            overwrite = TRUE)

  # read csv
  dbSpatial(conn = duckdb_conn,
            name = "test_points",
            value = test_file,
            x_colName = "x",
            y_colName = "y",
            overwrite = TRUE)
  unlink(test_file)
  DBI::dbDisconnect(duckdb_conn, shutdown = TRUE)
}

dbSpatial Package Global Options

Description

Global options to control package behavior.

Details

Use options() to set the below options.

Options

dbSpatial.max_print: integer. Max characters for WKT in show method (default 30).
dbSpatial.max_mem_convert: numeric. Max bytes for implicit coercion (default 8GB).
dbSpatial.verbose: logical. Print info messages during coercion (default TRUE).

Examples

options(dbSpatial.max_print = 50)
options(dbSpatial.max_mem_convert = 16 * 1024^3)
options(dbSpatial.verbose = FALSE)

head method for dbSpatial

Description

head method for dbSpatial

Usage

## S4 method for signature 'dbSpatial'
head(x, n = 6L, ...)

Arguments

x

A dbSpatial object.

n

Number of rows to return.

...

Additional arguments.

Value

A dbSpatial object containing the first n rows of x.

Install and/or load DuckDB spatial extension

Description

Install and/or load DuckDB spatial extension

Usage

loadSpatial(conn)

Arguments

conn

duckdb connection

Value

No return value, called for side effects. Installs and loads the DuckDB spatial extension for conn.

Examples

if (interactive() && requireNamespace("duckdb", quietly = TRUE)) {
  duckdb_conn = DBI::dbConnect(duckdb::duckdb(), ":memory:")
  DBI::dbExecute(duckdb_conn, "SET threads = 1")
  loadSpatial(conn = duckdb_conn)
  DBI::dbDisconnect(duckdb_conn, shutdown = TRUE)
}

show method for dbSpatial

Description

Show method for dbSpatial

Usage

## S4 method for signature 'dbSpatial'
show(object)

Arguments

object

A dbSpatial object.

Get area of geometries

Description

Returns the area of the geometry column.

Arguments

x

dbSpatial object

geomName

character string. The geometry column name. Default: "geom".

...

additional arguments passed to methods

Value

dbSpatial object (lazy tibble with area column)

Examples


if (interactive() && requireNamespace("duckdb", quietly = TRUE)) {
  square <- sf::st_sf(
    id = 1,
    geom = sf::st_sfc(
      sf::st_polygon(list(rbind(
        c(0, 0), c(1, 0), c(1, 1), c(0, 1), c(0, 0)
      )))
    )
  )
  duckdb_conn <- DBI::dbConnect(duckdb::duckdb(), ":memory:")
  DBI::dbExecute(duckdb_conn, "SET threads = 1")
  x <- as_dbSpatial(square, conn = duckdb_conn, name = "square",
                    overwrite = TRUE)
  st_area(x)
  DBI::dbDisconnect(duckdb_conn, shutdown = TRUE)
}

Convert to GeoJSON

Description

Returns the GeoJSON representation of the geometry.

Usage

st_as_geojson(x, ...)

## S3 method for class 'dbSpatial'
st_as_geojson(x, ...)

Arguments

x

dbSpatial object

...

additional arguments

Value

dbSpatial object with GeoJSON column

Functions

st_as_geojson(dbSpatial): Method for dbSpatial objects

Examples


if (interactive() && requireNamespace("duckdb", quietly = TRUE)) {
  point <- sf::st_sf(id = 1, geom = sf::st_sfc(sf::st_point(c(1, 2))))
  duckdb_conn <- DBI::dbConnect(duckdb::duckdb(), ":memory:")
  DBI::dbExecute(duckdb_conn, "SET threads = 1")
  x <- as_dbSpatial(point, conn = duckdb_conn, name = "point",
                    overwrite = TRUE)
  st_as_geojson(x)
  DBI::dbDisconnect(duckdb_conn, shutdown = TRUE)
}

Convert dbSpatial objects to sf objects

Description

S3 method implementation for converting dbSpatial objects to sf objects.

Usage

## S3 method for class 'dbSpatial'
st_as_sf(x, geomName = "geom", select = tidyselect::everything(), ...)

Arguments

x

A dbSpatial object to convert

geomName

character string. The geometry column name in the dbSpatial object. Default: "geom".

select

Columns to retain in output (default: all columns)

...

Additional arguments passed to sf::st_read

Details

This method handles conversion of dbSpatial to sf::sf objects using:

Dynamic column selection via tidyselect semantics
Automatic geometry column preservation
SQL-level column subsetting for efficiency

Value

An sf::sf object

Convert to WKT

Description

Returns the Well-Known Text (WKT) representation of the geometry.

Arguments

x

dbSpatial object

...

additional arguments

Value

dbSpatial object with WKT column

Examples


if (interactive() && requireNamespace("duckdb", quietly = TRUE)) {
  point <- sf::st_sf(id = 1, geom = sf::st_sfc(sf::st_point(c(1, 2))))
  duckdb_conn <- DBI::dbConnect(duckdb::duckdb(), ":memory:")
  DBI::dbExecute(duckdb_conn, "SET threads = 1")
  x <- as_dbSpatial(point, conn = duckdb_conn, name = "point",
                    overwrite = TRUE)
  st_as_text(x)
  DBI::dbDisconnect(duckdb_conn, shutdown = TRUE)
}

Compute bounding box for dbSpatial object

Description

Returns the bounding box of the geometry column.

Usage

## S3 method for class 'dbSpatial'
st_bbox(obj, ...)

Arguments

obj

dbSpatial object

...

additional arguments passed to methods

Value

bbox object (named numeric vector with xmin, ymin, xmax, ymax)

Compute buffer around geometry

Description

Returns a geometry that represents all points whose distance from this Geometry is less than or equal to distance.

Arguments

x

dbSpatial object

dist

numeric distance

...

additional arguments

Value

dbSpatial object with buffered geometry

Examples


if (interactive() && requireNamespace("duckdb", quietly = TRUE)) {
  point <- sf::st_sf(id = 1, geom = sf::st_sfc(sf::st_point(c(0, 0))))
  duckdb_conn <- DBI::dbConnect(duckdb::duckdb(), ":memory:")
  DBI::dbExecute(duckdb_conn, "SET threads = 1")
  x <- as_dbSpatial(point, conn = duckdb_conn, name = "point",
                    overwrite = TRUE)
  st_buffer(x, dist = 1)
  DBI::dbDisconnect(duckdb_conn, shutdown = TRUE)
}

Compute centroid of geometry

Description

Returns the geometric center of a geometry.

Arguments

x

dbSpatial object

...

additional arguments

Value

dbSpatial object with centroid geometry

Examples


if (interactive() && requireNamespace("duckdb", quietly = TRUE)) {
  square <- sf::st_sf(
    id = 1,
    geom = sf::st_sfc(
      sf::st_polygon(list(rbind(
        c(0, 0), c(1, 0), c(1, 1), c(0, 1), c(0, 0)
      )))
    )
  )
  duckdb_conn <- DBI::dbConnect(duckdb::duckdb(), ":memory:")
  DBI::dbExecute(duckdb_conn, "SET threads = 1")
  x <- as_dbSpatial(square, conn = duckdb_conn, name = "square",
                    overwrite = TRUE)
  st_centroid(x)
  DBI::dbDisconnect(duckdb_conn, shutdown = TRUE)
}

Get geometry types (DuckDB-native)

Description

Returns the geometry type for each row in a dbSpatial object using DuckDB's spatial function ST_GeometryType().

Usage

st_geometrytype(dbSpatial, geomName = "geom", collect = FALSE, n = NULL, ...)

Arguments

dbSpatial

A dbSpatial object.

geomName

Geometry column name. Default: "geom".

collect

Logical (default = FALSE). If TRUE, collect results into a character vector.

n

Optional integer. If provided alongside collect = TRUE, limits the query to the first n rows before collecting.

...

Additional arguments (ignored).

Value

If collect = FALSE (default), a lazy tibble with a single column geom_type. If collect = TRUE, a character vector of geometry type(s).

Spatial join for dbSpatial objects

Description

Performs a spatial join between two dbSpatial objects using a specified spatial predicate function.

Usage

## S3 method for class 'dbSpatial'
st_join(x, y, join = st_intersects, suffix = c(".x", ".y"), ...)

Arguments

x

A dbSpatial object.

y

A dbSpatial object.

join

Spatial predicate function to use for the join. Default is st_intersects. Supported predicates: st_intersects, st_contains, st_within, st_covers, st_covered_by, st_crosses, st_disjoint, st_equals, st_touches, st_overlaps.

suffix

Character vector of length 2. Suffixes to add to duplicate column names from x and y. Default is c(".x", ".y").

...

Additional arguments passed to the internal join function.

Details

This function follows the sf pattern where spatial predicates are passed as the join argument.

Value

A dbSpatial object containing the spatial join result.

Examples

if (interactive() && requireNamespace("duckdb", quietly = TRUE)) {
  con <- DBI::dbConnect(duckdb::duckdb(), ":memory:")
  DBI::dbExecute(con, "SET threads = 1")

  df1 <- data.frame(id = 1:3, x = c(0, 10, 20), y = c(0, 10, 20))
  pts1 <- dbSpatial(conn = con, name = "pts1", value = df1,
                    x_colName = "x", y_colName = "y", overwrite = TRUE)

  df2 <- data.frame(id = 4:6, x = c(0, 15, 25), y = c(0, 15, 25))
  pts2 <- dbSpatial(conn = con, name = "pts2", value = df2,
                    x_colName = "x", y_colName = "y", overwrite = TRUE)

  # Spatial join using intersection
  result <- sf::st_join(pts1, pts2, join = sf::st_intersects)

  # Spatial join using within predicate
  result <- sf::st_join(pts1, pts2, join = sf::st_within)

  DBI::dbDisconnect(con, shutdown = TRUE)
}

Get length of geometries

Description

Returns the length of the geometry column.

Arguments

x

dbSpatial object

geomName

character string. The geometry column name. Default: "geom".

...

additional arguments passed to methods

Value

dbSpatial object (lazy tibble with length column)

Examples


if (interactive() && requireNamespace("duckdb", quietly = TRUE)) {
  line <- sf::st_sf(
    id = 1,
    geom = sf::st_sfc(
      sf::st_linestring(rbind(c(0, 0), c(1, 1), c(2, 1)))
    )
  )
  duckdb_conn <- DBI::dbConnect(duckdb::duckdb(), ":memory:")
  DBI::dbExecute(duckdb_conn, "SET threads = 1")
  x <- as_dbSpatial(line, conn = duckdb_conn, name = "line",
                    overwrite = TRUE)
  st_length(x)
  DBI::dbDisconnect(duckdb_conn, shutdown = TRUE)
}

Get number of points

Description

Returns the number of points in a geometry.

Usage

st_npoints(x, ...)

## S4 method for signature 'dbSpatial'
st_npoints(x, ...)

Arguments

x

dbSpatial object

...

additional arguments

Value

dbSpatial object with npoints column

Methods (by class)

st_npoints(dbSpatial): Method for dbSpatial objects

Examples


if (interactive() && requireNamespace("duckdb", quietly = TRUE)) {
  line <- sf::st_sf(
    id = 1,
    geom = sf::st_sfc(sf::st_linestring(rbind(c(0, 0), c(1, 1), c(2, 1))))
  )
  duckdb_conn <- DBI::dbConnect(duckdb::duckdb(), ":memory:")
  DBI::dbExecute(duckdb_conn, "SET threads = 1")
  x <- as_dbSpatial(line, conn = duckdb_conn, name = "line",
                    overwrite = TRUE)
  st_npoints(x)
  DBI::dbDisconnect(duckdb_conn, shutdown = TRUE)
}

Get perimeter of geometries

Description

Returns the perimeter of the geometry column.

Arguments

x

dbSpatial object

geomName

character string. The geometry column name. Default: "geom".

...

additional arguments passed to methods

Value

dbSpatial object (lazy tibble with perimeter column)

Examples


if (interactive() && requireNamespace("duckdb", quietly = TRUE)) {
  square <- sf::st_sf(
    id = 1,
    geom = sf::st_sfc(
      sf::st_polygon(list(rbind(
        c(0, 0), c(1, 0), c(1, 1), c(0, 1), c(0, 0)
      )))
    )
  )
  duckdb_conn <- DBI::dbConnect(duckdb::duckdb(), ":memory:")
  DBI::dbExecute(duckdb_conn, "SET threads = 1")
  x <- as_dbSpatial(square, conn = duckdb_conn, name = "square",
                    overwrite = TRUE)
  st_perimeter(x)
  DBI::dbDisconnect(duckdb_conn, shutdown = TRUE)
}

Simplify geometry

Description

Returns a simplified version of the given geometry using the Douglas-Peucker algorithm.

Arguments

x

dbSpatial object

dTolerance

numeric tolerance

...

additional arguments

Value

dbSpatial object with simplified geometry

Examples


if (interactive() && requireNamespace("duckdb", quietly = TRUE)) {
  line <- sf::st_sf(
    id = 1,
    geom = sf::st_sfc(
      sf::st_linestring(rbind(
        c(0, 0), c(0.5, 0.2), c(1, 0), c(1.5, 0.1), c(2, 0)
      ))
    )
  )
  duckdb_conn <- DBI::dbConnect(duckdb::duckdb(), ":memory:")
  DBI::dbExecute(duckdb_conn, "SET threads = 1")
  x <- as_dbSpatial(line, conn = duckdb_conn, name = "line",
                    overwrite = TRUE)
  st_simplify(x, dTolerance = 0.1)
  DBI::dbDisconnect(duckdb_conn, shutdown = TRUE)
}

Translate x, y coordinates by delta x, delta y for point geometries

Description

This function translates point geometries by the specified delta x and delta y values.

Usage

st_translate(dbSpatial, geomName = "geom", dx, dy, ...)

## S4 method for signature 'dbSpatial'
st_translate(dbSpatial, geomName = "geom", dx, dy, ...)

Arguments

dbSpatial

dbSpatial object.

geomName

character string. The geometry column name in the dbSpatial object. Default: "geom".

dx

numeric.value to shift x coordinates by

dy

numeric. value to shift y coordinates by

...

additional arguments passed to methods

Value

dbSpatial object

Functions

st_translate(dbSpatial): Method for dbSpatial object

Examples

if (interactive() && requireNamespace("duckdb", quietly = TRUE)) {
  con = DBI::dbConnect(duckdb::duckdb(), ":memory:")
  DBI::dbExecute(con, "SET threads = 1")

  coordinates <- data.frame(x = c(100, 200, 300), y = c(500, 600, 700))
  attributes <- data.frame(id = 1:3, name = c("A", "B", "C"))

  # Combine the coordinates and attributes
  dummy_data <- cbind(coordinates, attributes)

  points <- dbSpatial(conn = con,
                      name = "points",
                      value = dummy_data,
                      overwrite = TRUE,
                      x_colName = "x",
                      y_colName = "y")

  points

  points_translated <- st_translate(dbSpatial = points, dx = 100, dy = -20)

  points_translated
  DBI::dbDisconnect(con, shutdown = TRUE)
}

Get X coordinate

Description

Returns the X coordinate of a point.

Usage

st_x(x, ...)

## S4 method for signature 'dbSpatial'
st_x(x, ...)

Arguments

x

dbSpatial object

...

additional arguments

Value

dbSpatial object with X coordinate column

Methods (by class)

st_x(dbSpatial): Method for dbSpatial objects

Examples


if (interactive() && requireNamespace("duckdb", quietly = TRUE)) {
  point <- sf::st_sf(id = 1, geom = sf::st_sfc(sf::st_point(c(1, 2))))
  duckdb_conn <- DBI::dbConnect(duckdb::duckdb(), ":memory:")
  DBI::dbExecute(duckdb_conn, "SET threads = 1")
  x <- as_dbSpatial(point, conn = duckdb_conn, name = "point",
                    overwrite = TRUE)
  st_x(x)
  DBI::dbDisconnect(duckdb_conn, shutdown = TRUE)
}

Get maximum x coordinate

Description

This function returns the maximum x coordinate in each geometry in the specified dbSpatial object.

Usage

st_xmax(dbSpatial, geomName = "geom", ...)

## S4 method for signature 'dbSpatial'
st_xmax(dbSpatial, geomName = "geom", ...)

Arguments

dbSpatial

dbSpatial object.

geomName

character string. The geometry column name in the dbSpatial object. Default: "geom".

...

additional arguments passed to methods

Value

numerical column vector in database

Functions

st_xmax(dbSpatial): Method for dbSpatial object

Examples

if (interactive() && requireNamespace("duckdb", quietly = TRUE)) {
  # Create a data.frame with x and y coordinates and attributes
  coordinates <- data.frame(x = c(100, 200, 300), y = c(500, 600, 700))
  attributes <- data.frame(id = 1:3, name = c("A", "B", "C"))

  # Combine the coordinates and attributes
  dummy_data <- cbind(coordinates, attributes)

  # Create a duckdb connection
  con = DBI::dbConnect(duckdb::duckdb(), ":memory:")
  DBI::dbExecute(con, "SET threads = 1")

  # Create a duckdb table with spatial points
  db_points = dbSpatial(conn = con,
                        value = dummy_data,
                        x_colName = "x",
                        y_colName = "y",
                        name = "foo",
                        overwrite = TRUE)

  st_xmax(dbSpatial = db_points)
  DBI::dbDisconnect(con, shutdown = TRUE)
}

Get Y coordinate

Description

Returns the Y coordinate of a point.

Usage

st_y(x, ...)

## S4 method for signature 'dbSpatial'
st_y(x, ...)

Arguments

x

dbSpatial object

...

additional arguments

Value

dbSpatial object with Y coordinate column

Methods (by class)

st_y(dbSpatial): Method for dbSpatial objects

Examples


if (interactive() && requireNamespace("duckdb", quietly = TRUE)) {
  point <- sf::st_sf(id = 1, geom = sf::st_sfc(sf::st_point(c(1, 2))))
  duckdb_conn <- DBI::dbConnect(duckdb::duckdb(), ":memory:")
  DBI::dbExecute(duckdb_conn, "SET threads = 1")
  x <- as_dbSpatial(point, conn = duckdb_conn, name = "point",
                    overwrite = TRUE)
  st_y(x)
  DBI::dbDisconnect(duckdb_conn, shutdown = TRUE)
}

Get maximum y coordinate

Description

This function returns the maximum y coordinate of the geometries in the specified dbSpatial object.

Usage

st_ymax(dbSpatial, geomName = "geom", ...)

## S4 method for signature 'dbSpatial'
st_ymax(dbSpatial, geomName = "geom", ...)

Arguments

dbSpatial

dbSpatial object.

geomName

character string. The geometry column name in the dbSpatial object. Default: "geom".

...

additional arguments passed to methods

Value

numerical column vector in database

Functions

st_ymax(dbSpatial): Method for dbSpatial object

Examples

if (interactive() && requireNamespace("duckdb", quietly = TRUE)) {
  # Create a data.frame with x and y coordinates and attributes
  coordinates <- data.frame(x = c(100, 200, 300), y = c(500, 600, 700))
  attributes <- data.frame(id = 1:3, name = c("A", "B", "C"))

  # Combine the coordinates and attributes
  dummy_data <- cbind(coordinates, attributes)

  # Create a duckdb connection
  con = DBI::dbConnect(duckdb::duckdb(), ":memory:")
  DBI::dbExecute(con, "SET threads = 1")

  # Create a duckdb table with spatial points
  db_points = dbSpatial(conn = con,
                        value = dummy_data,
                        x_colName = "x",
                        y_colName = "y",
                        name = "foo",
                        overwrite = TRUE)

  st_ymax(dbSpatial = db_points)
  DBI::dbDisconnect(con, shutdown = TRUE)
}

tail method for dbSpatial

Description

tail method for dbSpatial

Usage

## S4 method for signature 'dbSpatial'
tail(x, n = 6L, ...)

Arguments

x

A dbSpatial object.

n

Number of rows to return.

...

Additional arguments.

Value

A dbSpatial object containing the last n rows of x.

Create SpatVector objects

Description

Create SpatVector objects

Usage

## S4 method for signature 'dbSpatial'
vect(x, select = tidyselect::everything(), ...)

Arguments

x

A dbSpatial object to convert into a terra::SpatVector object

select

Columns to retain in output (default: all columns)

...

Additional arguments passed to sf::st_as_sf

Value

A terra::SpatVector containing the selected columns and geometry materialized from x.

Examples


if (interactive() && requireNamespace("duckdb", quietly = TRUE)) {
  point_data <- data.frame(x = c(100, 200), y = c(500, 600), id = 1:2)
  point_vect <- terra::vect(point_data, geom = c("x", "y"))
  duckdb_conn <- DBI::dbConnect(duckdb::duckdb(), ":memory:")
  DBI::dbExecute(duckdb_conn, "SET threads = 1")
  dbs <- as_dbSpatial(point_vect, conn = duckdb_conn, name = "point_vect",
                      overwrite = TRUE)
  terra::vect(dbs)
  DBI::dbDisconnect(duckdb_conn, shutdown = TRUE)
}

Package {dbSpatial}

Column extraction for dbSpatial

Description

Usage

Arguments

Value

Simulate basic dbSpatial object

Description

Usage

Arguments

Details

Value

Ingest spatial data from a file as a VIEW and create a dbSpatial object

Description

Usage

Arguments

Details

Value

Base function for spatial joins

Description

Usage

Arguments

Details

Value

Convert an sf or terra object to a dbSpatial object

Description

Usage

Arguments

Details

Value

See Also

Examples

Create a dbSpatial object with geometry data type

Description

Usage

Arguments

Details

Value

See Also

Examples

dbSpatial Package Global Options

Description

Details

Options

Examples

head method for dbSpatial

Description

Usage

Arguments

Value

See Also

Install and/or load DuckDB spatial extension

Description

Usage

Arguments

Value

Examples

show method for dbSpatial

Description

Usage

Arguments

See Also

Get area of geometries

Description

Arguments

Value

See Also

Examples

Convert to GeoJSON

Description

Usage

Arguments

Value

Functions

See Also

Examples

Convert dbSpatial objects to sf objects

Description

Usage

Arguments

Ingest spatial data from a file as a `VIEW` and create a `dbSpatial` object

Convert an sf or terra object to a `dbSpatial` object

Create a `dbSpatial` object with geometry data type