Skip to content

Commit

Permalink
docs: Add dev installation instructions, CC @hannes
Browse files Browse the repository at this point in the history
  • Loading branch information
krlmlr committed Sep 26, 2023
1 parent 6bd7d6c commit 2b673dc
Showing 1 changed file with 33 additions and 16 deletions.
49 changes: 33 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,57 +1,74 @@
<img src="https://duckdb.org/images/logo-dl/DuckDB_Logo.png" height="120">
<img src="https://duckdb.org/images/logo-dl/DuckDB_Logo.png" height="120"/>

# duckdb R package

## Installation from CRAN

```r
``` r
install.packages("duckdb")
```

## Installation from r-universe

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

## Installation from GitHub

``` r
# 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](https://duckdb.org/docs/api/r).

## Building

To build the bleeding edge of duckdb-r, you can clone this repository and run
To build the bleeding edge of duckdb-r, you can clone this repository and run

```sh
``` sh
~duckdb-r: R CMD INSTALL .
```

If you wish to test new duckdb functionality with duckdb-r, make sure your clones of `duckdb-r` and `duckdb` share the same parent directory. Then run the following commands
```sh
If you wish to test new duckdb functionality with duckdb-r, make sure your clones of `duckdb-r` and `duckdb` share the same parent directory.
Then run the following commands

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

It helps if both the duckdb directory and duckdb-r directory are clean. If you encounter linker errors, merge both duckdb-r and duckdb with their respective main branches.

It helps if both the duckdb directory and duckdb-r directory are clean.
If you encounter linker errors, merge both duckdb-r and duckdb with their respective main branches.

## Dependencies

To build the R package, you first need to install the dependencies:

```r
``` r
# 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()
```

### Developing with Extensions
If you wish to build or add extensions to the R package you first need to build duckdb with the
`extension_static_build` flag. The following commands allow you to add the httpfs extension to
a duckdb R build. See the [extension ReadMe](https://github.com/duckdb/duckdb/tree/master/extension#readme) for more
information about extensions
```sh

If you wish to build or add extensions to the R package you first need to build duckdb with the `extension_static_build` flag.
The following commands allow you to add the httpfs extension to a duckdb R build.
See the [extension ReadMe](https://github.com/duckdb/duckdb/tree/master/extension#readme) for more information about extensions

``` sh
cd duckdb/
EXTENSION_STATIC_BUILD=1 make
```

Then in R
```r

``` r
library(duckdb)
con <- DBI::dbConnect(duckdb(config=list('allow_unsigned_extensions'='true')))
dbExecute(con, "LOAD '{{path_to_duckdb}}/build/release/extension/httpfs/httpfs.duckdb_extension'")
```

0 comments on commit 2b673dc

Please sign in to comment.