Package index • duckspatial

Setup and Connection

Install the spatial extension and manage DuckDB connections

ddbs_create_conn(): Create a DuckDB connection with spatial extension
ddbs_stop_conn(): Close a DuckDB connection
ddbs_install(): Checks and installs the Spatial extension
ddbs_load(): Loads the Spatial extension
ddbs_options(): Get or set global duckspatial options
ddbs_set_resources() ddbs_get_resources(): Get or set connection resources
ddbs_sitrep(): Report duckspatial configuration status

Read and write spatial data to and from DuckDB

Test spatial relationships between geometries

ddbs_predicate() ddbs_intersects() ddbs_covers() ddbs_touches() ddbs_is_within_distance() ddbs_disjoint() ddbs_within() ddbs_contains() ddbs_overlaps() ddbs_crosses() ddbs_equals() ddbs_covered_by() ddbs_intersects_extent() ddbs_contains_properly() ddbs_within_properly(): Evaluate spatial predicates between geometries

Combine or subset geometries based on spatial relationships

ddbs_intersection() ddbs_difference() ddbs_sym_difference(): Geometry binary operations
ddbs_filter(): Perform a spatial filter
ddbs_interpolate_aw(): Areal-Weighted Interpolation using DuckDB
ddbs_join(): Perform a spatial join of two geometries

Create new geometries from scratch or from existing data

ddbs_as_spatial(): Generate point geometries from coordinates
ddbs_generate_points(): Generate random points within bounding boxes of geometries
ddbs_quadkey(): Convert point geometries to QuadKey tiles

Modify, simplify, and transform individual geometries

ddbs_boundary(): Get the boundary of geometries
ddbs_buffer(): Creates a buffer around geometries
ddbs_build_area(): Build polygon areas from multiple linestrings
ddbs_centroid(): Calculates the centroid of geometries
ddbs_concave_hull(): Compute the concave hull of geometries
ddbs_convex_hull(): Compute the convex hull of geometries
ddbs_endpoint(): Extracts the endpoint of a linestring geometry
ddbs_exterior_ring(): Extract the exterior ring of polygons
ddbs_make_polygon(): Create a polygon from a single closed linestring
ddbs_polygonize(): Assemble polygons from multiple linestrings
ddbs_union() ddbs_combine() ddbs_union_agg(): Union and combine geometries
ddbs_voronoi(): Computes a Voronoi diagram from point geometries

Transform and manipulate coordinate systems

Check and repair geometry validity and dimensionality

ddbs_geometry_type(): Get the geometry type of features
ddbs_make_valid(): Make invalid geometries valid
ddbs_simplify(): Simplify geometries
ddbs_is_simple() ddbs_is_valid() ddbs_is_closed() ddbs_is_empty() ddbs_is_ring(): Geometry validation functions
ddbs_has_z() ddbs_has_m(): Check geometry dimensions
ddbs_force_2d() ddbs_force_3d() ddbs_force_4d(): Force geometry dimensions

Convert geometries to and from standard spatial formats

ddbs_as_text() ddbs_as_wkb() ddbs_as_hexwkb() ddbs_as_geojson(): Convert geometries to standard interchange formats

Extract bounding boxes and envelopes

Rotate, scale, shear, and shift geometries

Calculate areas, distances, lengths, and perimeters

ddbs_area() ddbs_length() ddbs_perimeter() ddbs_distance(): Calculate geometric measurements

Helper functions for managing DuckDB schemas and metadata

Create and work with lazy duckspatial_df objects

as_duckspatial_df(): Convert objects to duckspatial_df
is_duckspatial_df(): Check if object is a duckspatial_df
collect(<duckspatial_df>) ddbs_collect(): Collect a duckspatial_df with flexible output formats
ddbs_compute(): Force computation of a lazy duckspatial_df
ddbs_geom_col(): Get the geometry column name
st_crs(<duckspatial_df>) st_geometry(<duckspatial_df>) st_bbox(<duckspatial_df>) st_as_sf(<duckspatial_df>) print(<duckspatial_df>): sf methods for duckspatial_df
dplyr_reconstruct(<duckspatial_df>) left_join(<duckspatial_df>) inner_join(<duckspatial_df>) head(<duckspatial_df>) count(<duckspatial_df>) glimpse(<duckspatial_df>) compute(<duckspatial_df>) distinct(<duckspatial_df>): dplyr methods for duckspatial_df