rpostgis-package: rpostgis: R Interface to a PostGIS Database

In rpostgis: R Interface to a 'PostGIS' Database

rpostgis: R Interface to a PostGIS Database

Description

The rpostgis package provides an interface between R and PostGIS-enabled PostgreSQL databases, allowing seamless transfer of spatial data. It supports both vector (points, lines, polygons) and raster data for reading and writing. Additionally, it offers convenience functions to perform common operations within PostgreSQL/PostGIS.

Features

• Vector Data Support: Points, lines, polygons

• Raster Data Support: Read and write raster data

• PostGIS Functions: Convenient wrappers for common PostGIS tasks

• PostgreSQL Connectivity: Interface for database interaction

Getting Started

1. Loading the package and connecting to a database To begin, load the rpostgis package and establish a connection to a PostgreSQL database:

library(rpostgis)
con <- dbConnect("PostgreSQL", dbname = "<dbname>", host = "<host>",
                 user = "<user>", password = "<password>")

Example:

con <- dbConnect("PostgreSQL", dbname = "rpostgis", host = "localhost",
                 user = "postgres", password = "postgres")

2. Checking and Installing PostGIS Verify if PostGIS is installed on the database. If not, it will attempt to install it:

pgPostGIS(con)

This function should return TRUE invisibly when PostGIS is installed and ready for use.

3. Closing the Database Connection After finishing your work, make sure to close the connection:

dbDisconnect(con)

List of Functions

To view a list of all available functions in rpostgis, use:

library(help = "rpostgis")

Additional Notes

• Ensure your PostgreSQL instance is PostGIS-enabled before using rpostgis functions.

• The functions provided simplify working with spatial data and interacting with a PostGIS-enabled database.

Author(s)

Maintainer: Adrián Cidre González [e-mail] (ORCID)

Authors:

• Mathieu Basille [e-mail] (ORCID)

• David Bucklin [e-mail]

See Also

Useful links:

• https://cidree.github.io/rpostgis/

• https://github.com/Cidree/rpostgis

• Report bugs at https://github.com/Cidree/rpostgis/issues

rpostgis documentation built on April 12, 2025, 1:33 a.m.