ltla / tiledb-r

R interface to the TileDB storage manager

TileDB-R

The TileDB R package offers an R interface to the storage engine of TileDB.

Note that the R interface to TileDB is under development, and the API is subject to change.

Documentation

Documentation is available for the R package as well as for the TileDB API.

Installation

TileDB Embedded needs to be present, and can be installed first (from a package or from source) for the TileDB R package to build and link correctly. Alternatively, if no system installation is found, a precompiled shared library is used during the installation of this R package.

The TileDB R package has been published on CRAN and be installed directly via

> install.packages("tiledb")

as usual.

The most recent released version can be installed from Github using the package remotes.

> if (!requireNamespace("remotes",quietly=TRUE)) install.packages("remotes")
> remotes::install_github("TileDB-Inc/TileDB-R")
...
> library(tiledb)
> tiledb_version()
major minor patch
    2     0     8
> help(package=tiledb)

If the TileDB library is installed in a custom location, you need to pass the explicit path:

> remotes::install_github("TileDB-Inc/TileDB-R",
      args="--configure-args='--with-tiledb=/path/to/tiledb'")

Note that the TileDB R package is developed and tested against the latest stable (v2.0.x) version of TileDB, but should also build against the newest development version.

Quick Links

• TileDB Installation
• TileDB R Package Docs
• Full documentation for all APIs and integrations
• TileDB Support Forum

Copyright

The TileDB R package is Copyright 2018-2020 TileDB, Inc

License

MIT