The hardware and bandwidth for this mirror is donated by METANET, the Webhosting and Full Service-Cloud Provider.
If you wish to report a bug, or if you are interested in having us mirror your free-software or open-source project, please feel free to contact us at mirror[@]metanet.ch.

duckdb

DuckDB is an in-process SQL OLAP database management system. It is designed to support analytical query workloads and is optimized for fast query execution. This repository contains the R bindings for DuckDB.

Installation from CRAN

Installing the package from source may take up to an hour. Consider using binary Windows/macOS packages from CRAN for recent R versions, or Posit Package Manager for various flavors of Linux or older R versions.

install.packages("duckdb")

Installation from r-universe

Installing the package from source may take up to an hour. Binaries are available for recent versions of R. Review https://docs.r-universe.dev/install/binaries.html for configuring installation of binary packages on Linux.

install.packages("duckdb", repos = c("https://duckdb.r-universe.dev", "https://cloud.r-project.org"))

Installation from GitHub

Installing the package from GitHub may take up to an hour.

# install.packages("pak", repos = sprintf("https://r-lib.github.io/p/pak/stable/%s/%s/%s", .Platform$pkgType, R.Version()$os, R.Version()$arch))
pak::pak("duckdb/duckdb-r")

User Guide

See the R API in the DuckDB documentation.

Building

To build the R package, you first need to clone this repository and install the dependencies:

# install.packages("pak", repos = sprintf("https://r-lib.github.io/p/pak/stable/%s/%s/%s", .Platform$pkgType, R.Version()$os, R.Version()$arch))
pak::pak()

Then, install:

~duckdb-r: R CMD INSTALL .

Set the MAKEFLAGS environment variable to -j8 or similar for parallel builds. Configure ccache for faster repeated builds.

If you wish to test new DuckDB functionality with duckdb-r, make sure your clone of duckdb-r is one level deeper than your clone of duckdb (e.g. R/duckdb-r and duckdb). Then run the following commands:

~ (cd duckdb && git checkout {{desired_branch}})
~ (cd R/duckdb-r && scripts/vendor.sh)
~ (cd R/duckdb-r && R CMD INSTALL .)

It helps if both the duckdb directory and duckdb-r directory are clean.

Contributors

Thanks to all contributors to this repository, and to those who contributed when the code was still hosted in the main duckdb/duckdb repository:

Mark Raasveldt, Pedro Holanda, Tom Ebergen, Reijo Sund, Nicolas Bennett, Patrik Schratz, Tishj, Laurens Kuiper, Sam Ansmink, Andy Teucher, Hadley Wickham, Jonathan Keane, Lindsay Wray, Richard Wesley, Elliana May, Edwin de Jonge, Dewey Dunnington, Carlo Piovesan, Andre Beckedorf, Tania Bogatsch, Pedro Ferreira, Maximilian Girlich, James Lamb, James Atkins, usurai, Ubuntu, Noam Ross, Michael Antonov, Jeroen Ooms, Jamie Lentin, Jacob, and Chilarai.

These binaries (installable software) and packages are in development.
They may not be fully stable and should be used with caution. We make no claims about them.