# R Interface to 'DuckDB' Database with Spatial Extension

## Documentation for package ‘duckspatial’ version 1.2.1

- DESCRIPTION file
- User guides, package vignettes and other documentation
- Package NEWS
- Package README

## Help Pages

A C D I

## -- A --

as_duckspatial_df | Convert objects to duckspatial_df
as_duckspatial_df.character | Convert objects to duckspatial_df
as_duckspatial_df.data.frame | Convert objects to duckspatial_df
as_duckspatial_df.duckspatial_df | Convert objects to duckspatial_df
as_duckspatial_df.sf | Convert objects to duckspatial_df
as_duckspatial_df.tbl_duckdb_connection | Convert objects to duckspatial_df
as_duckspatial_df.tbl_lazy | Convert objects to duckspatial_df
as_nanoarrow_array_stream.duckspatial_df | Convert a duckspatial_df to a nanoarrow_array_stream

## -- C --

collect.duckspatial_df | Collect a duckspatial_df with flexible output formats

## -- D --

ddbs_affine | Apply an affine transformation to geometries
ddbs_area | Calculate geometric measurements
ddbs_as_format | Convert geometries to standard interchange formats
ddbs_as_geojson | Convert geometries to standard interchange formats
ddbs_as_hexwkb | Convert geometries to standard interchange formats
ddbs_as_mvt_geom | Transform geometries into Mapbox Vector Tile coordinate space
ddbs_as_points | Generate point geometries from coordinates
ddbs_as_text | Convert geometries to standard interchange formats
ddbs_as_wkb | Convert geometries to standard interchange formats
ddbs_azimuth | Calculate geometric measurements
ddbs_bbox | Get the bounding box of geometries
ddbs_binary_funs | Geometry binary operations
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_collect | Collect a duckspatial_df with flexible output formats
ddbs_combine | Union and combine geometries
ddbs_compute | Force computation of a lazy duckspatial_df
ddbs_concave_hull | Compute the concave hull of geometries
ddbs_contains | Evaluate spatial predicates between geometries
ddbs_contains_properly | Evaluate spatial predicates between geometries
ddbs_convex_hull | Compute the convex hull of geometries
ddbs_coord_bounds | Coordinate bounds of geometries
ddbs_covered_by | Evaluate spatial predicates between geometries
ddbs_covers | Evaluate spatial predicates between geometries
ddbs_create_conn | Create a DuckDB connection with spatial extension
ddbs_create_schema | Check and create schema
ddbs_crop | Geometry binary operations
ddbs_crosses | Evaluate spatial predicates between geometries
ddbs_crs | Check CRS of spatial objects or database tables
ddbs_crs.character | Check CRS of spatial objects or database tables
ddbs_crs.crs | Check CRS of spatial objects or database tables
ddbs_crs.data.frame | Check CRS of spatial objects or database tables
ddbs_crs.default | Check CRS of spatial objects or database tables
ddbs_crs.duckdb_connection | Check CRS of spatial objects or database tables
ddbs_crs.duckspatial_df | Check CRS of spatial objects or database tables
ddbs_crs.numeric | Check CRS of spatial objects or database tables
ddbs_crs.sf | Check CRS of spatial objects or database tables
ddbs_crs.tbl_duckdb_connection | Check CRS of spatial objects or database tables
ddbs_difference | Geometry binary operations
ddbs_dimension | Get the topological dimension of a geometry
ddbs_disjoint | Evaluate spatial predicates between geometries
ddbs_distance | Calculate geometric measurements
ddbs_drivers | Get list of GDAL drivers and file formats
ddbs_drop_geometry | Drop geometry column from a duckspatial_df object
ddbs_dump | Dumps geometries into their component parts
ddbs_endpoint_startpoint | Extract the start or end point of a linestring geometry
ddbs_envelope | Get the envelope (bounding box) of geometries
ddbs_equals | Evaluate spatial predicates between geometries
ddbs_extension_info | Glimpse the status of a DuckDB extension
ddbs_exterior_ring | Extract the exterior ring of polygons
ddbs_filter | Perform a spatial filter
ddbs_flip | Flip geometries horizontally or vertically
ddbs_flip_coordinates | Flips the X and Y coordinates of geometries
ddbs_force_2d | Force geometry dimensions
ddbs_force_3d | Force geometry dimensions
ddbs_force_4d | Force geometry dimensions
ddbs_force_dim | Force geometry dimensions
ddbs_generate_points | Generate random points within bounding boxes of geometries
ddbs_geometry_type | Get the geometry type of features
ddbs_geom_col | Get the geometry column name
ddbs_geom_from | Create geometries from standard interchange formats
ddbs_geom_from_geojson | Create geometries from standard interchange formats
ddbs_geom_from_hexewkb | Create geometries from standard interchange formats
ddbs_geom_from_hexwkb | Create geometries from standard interchange formats
ddbs_geom_from_text | Create geometries from standard interchange formats
ddbs_geom_from_wkb | Create geometries from standard interchange formats
ddbs_geom_validation_funs | Geometry validation functions
ddbs_get_ngeometries | Count geometry components
ddbs_get_ninterior_rings | Count geometry components
ddbs_get_npoints | Count geometry components
ddbs_get_resources | Get or set connection resources
ddbs_glimpse | Check first rows of the data
ddbs_has_dim | Check geometry dimensions
ddbs_has_m | Check geometry dimensions
ddbs_has_z | Check geometry dimensions
ddbs_install | Checks and installs the Spatial extension
ddbs_interpolate_aw | Areal-Weighted Interpolation using DuckDB
ddbs_intersection | Geometry binary operations
ddbs_intersection_agg | Aggregate the intersection of geometries
ddbs_intersects | Evaluate spatial predicates between geometries
ddbs_intersects_extent | Evaluate spatial predicates between geometries
ddbs_is_closed | Geometry validation functions
ddbs_is_empty | Geometry validation functions
ddbs_is_ring | Geometry validation functions
ddbs_is_simple | Geometry validation functions
ddbs_is_valid | Geometry validation functions
ddbs_is_within_distance | Evaluate spatial predicates between geometries
ddbs_join | Perform a spatial join of two geometries
ddbs_length | Calculate geometric measurements
ddbs_line_endpoint | Extract the start or end point of a linestring geometry
ddbs_line_interpolate | Interpolates a point or points along a line geometry
ddbs_line_locate_point | Locate a point along a linestring
ddbs_line_merge | Merge line geometries into a single line
ddbs_line_node | Node a set of linestrings
ddbs_line_startpoint | Extract the start or end point of a linestring geometry
ddbs_line_substring | Extract a substring of a line geometry
ddbs_list_tables | Check tables and schemas inside a database
ddbs_load | Loads the Spatial extension
ddbs_locate | Locate geometries at specific M values
ddbs_locate_along | Locate geometries at specific M values
ddbs_locate_between | Locate geometries at specific M values
ddbs_m | Extract coordinates from geometries
ddbs_make_envelope | Create a rectangular polygon from bounding coordinates
ddbs_make_line | Create lines from point geometries
ddbs_make_polygon | Create a polygon from a single closed linestring
ddbs_make_valid | Make invalid geometries valid
ddbs_maximum_inscribed_circle | Computes the maximum inscribed circle of a geometry
ddbs_measure_funs | Calculate geometric measurements
ddbs_minimum_rotated_rectangle | Computes the minimum rotated rectangle enclosing a geometry
ddbs_mmax | Coordinate bounds of geometries
ddbs_mmin | Coordinate bounds of geometries
ddbs_multi | Convert geometries to multi-type
ddbs_normalize | Normalize geometries to a canonical form
ddbs_open_dataset | Open spatial dataset lazily via DuckDB
ddbs_options | Get or set global duckspatial options
ddbs_overlaps | Evaluate spatial predicates between geometries
ddbs_perimeter | Calculate geometric measurements
ddbs_point | Create point geometries from coordinate vectors
ddbs_polygonize | Assemble polygons from multiple linestrings
ddbs_predicate | Evaluate spatial predicates between geometries
ddbs_quadkey | Convert point geometries to QuadKey tiles
ddbs_read_meta | Read metadata from a spatial file
ddbs_read_table | Reads a vectorial table from DuckDB into R
ddbs_reduce_precision | Reduce the coordinate precision of geometries
ddbs_register_table | Register an SF Object as an Arrow Table in DuckDB
ddbs_remove_repeated_points | Remove repeated points from a geometry
ddbs_reverse | Reverse the vertex order of geometries
ddbs_rotate | Rotate geometries around their centroid
ddbs_rotate_3d | Rotate 3D geometries around an axis
ddbs_scale | Scale geometries by X and Y factors
ddbs_set_crs | Set the coordinate reference system of geometries
ddbs_set_resources | Get or set connection resources
ddbs_shear | Shear geometries
ddbs_shift | Shift geometries by X and Y offsets
ddbs_shortest_line | Geometry binary operations
ddbs_simplify | Simplify geometries
ddbs_sitrep | Report duckspatial configuration status
ddbs_stop_conn | Close a DuckDB connection
ddbs_sym_difference | Geometry binary operations
ddbs_touches | Evaluate spatial predicates between geometries
ddbs_transform | Transform the coordinate reference system of geometries
ddbs_union | Union and combine geometries
ddbs_union_agg | Union and combine geometries
ddbs_union_funs | Union and combine geometries
ddbs_vertices | Collect all vertices of a geometry into a MULTIPOINT
ddbs_voronoi | Computes a Voronoi diagram from point geometries
ddbs_within | Evaluate spatial predicates between geometries
ddbs_within_properly | Evaluate spatial predicates between geometries
ddbs_write_dataset | Write spatial dataset to disk
ddbs_write_mbtiles | Write a Mapbox Vector Tile pyramid to an MBTiles file
ddbs_write_table | Write an SF Object to a DuckDB Database
ddbs_x | Extract coordinates from geometries
ddbs_xmax | Coordinate bounds of geometries
ddbs_xmin | Coordinate bounds of geometries
ddbs_xy | Extract coordinates from geometries
ddbs_y | Extract coordinates from geometries
ddbs_ymax | Coordinate bounds of geometries
ddbs_ymin | Coordinate bounds of geometries
ddbs_z | Extract coordinates from geometries
ddbs_zmax | Coordinate bounds of geometries
ddbs_zmin | Coordinate bounds of geometries

## -- I --

is_duckspatial_df | Check if object is a duckspatial_df