R interface to the TileDB storage manager
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
R
docs
examples
inst/include
man
src
tests
.Rbuildignore
.gitignore
.travis.yml
DESCRIPTION
LICENSE
NAMESPACE
README.md
TileDB-R.Rproj
_pkgdown.yml
configure
configure.ac

README.md

TileDB-R

Build Status

TileDB-R is a R interface to the TileDB Storage Manager.

Warning: The R interface to TileDB is under development and the API is subject to change.

Quickstart

TileDB needs to be installed beforehand (from a package or from source) for the TileDB-R package to build and link correctly:

> install.packages("devtools")
> library(devtools)
> devtools::install_github("TileDB-Inc/TileDB-R@latest")
...
> library(tiledb)
> tiledb::libtiledb_version()
major minor patch
1     3     0 
> help(tiledb)

Installation

The TileDB-Rpackage has not been published on CRAN and must be installed from source.

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

install.packages("devtools") 
library(devtools)
devtools::install_github("TileDB-Inc/TileDB-R@latest")

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

devtools::install_github("TileDB-Inc/TileDB-R@latest",
    args="--configure-args='--with-tiledb=/path/to/tiledb'"")

To build the latest development version of TileDB-R:

devtools::install_github("TileDB-Inc/TileDB-R")

Note The TileDB-R package is developed against latest stable (v1.3.x) version of TileDB

Conda

If you are using the TileDB Conda package, you may need to explicitly add the conda path after activating the environment with conda activate tiledb. More information on the TileDB conda installation documentation page.

Developer Documentation

Instructions for setting up a RStudio devlopment environment, building, and testing the TileDB-R package are located in the developer documentation wiki.