-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
- Loading branch information
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,64 +1,27 @@ | ||
# TileDB-R | ||
<a href="https://tiledb.com"><img src="https://github.com/TileDB-Inc/TileDB/raw/dev/doc/source/_static/[email protected]" alt="TileDB logo" width="400"></a> | ||
|
||
[![Build Status](https://travis-ci.org/TileDB-Inc/TileDB-R.svg?branch=master)](https://travis-ci.org/TileDB-Inc/TileDB-R) | ||
|
||
`TileDB-R` is a [R](https://www.r-project.org/) interface to the [TileDB Storage Manager](http://tiledb.io). | ||
|
||
**Warning**: The R interface to TileDB is under development and the API is subject to change. | ||
# TileDB-R | ||
|
||
## [Documentation](https://tiledb-inc.github.io/TileDB-R/) | ||
`TileDB-R` is a [R](https://www.r-project.org/) interface to the [TileDB Storage Manager](http://tiledb.com). | ||
|
||
## Quickstart | ||
**Warning**: The R interface to TileDB is under development and the API is subject to change. | ||
|
||
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/[email protected]") | ||
... | ||
> library(tiledb) | ||
> tiledb_version() | ||
major minor patch | ||
1 7 0 | ||
> version() | ||
major minor patch | ||
0 3 0 | ||
> help(tiledb) | ||
|
||
## Installation | ||
|
||
The `TileDB-R`package has not been published on [CRAN](https://cran.r-project.org/) | ||
and must be installed from source. | ||
|
||
The most recent released version can be installed from [Github](https://github.com/TileDB-Inc/TileDB-R) using the package [devtools](https://github.com/r-lib/devtools). | ||
|
||
install.packages("devtools") | ||
library(devtools) | ||
devtools::install_github("TileDB-Inc/[email protected]") | ||
|
||
If the TileDB library is installed in a custom location, you need to pass the explicit path: | ||
|
||
devtools::install_github("TileDB-Inc/[email protected]", | ||
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.7.x`) version of TileDB | ||
|
||
**Note** `install_github` will delete all temporary files upon failure. To debug build failures, clone this repository locally and run `devtools::install("/path/to/TileDB-R")`. | ||
|
||
### Conda | ||
TileDB needs to be installed beforehand (from a package or from source) | ||
for the TileDB-R package to build and link correctly. | ||
See the [official installation docs](https://docs.tiledb.com/developer/installation) | ||
for details on installing libtiledb and the R api. | ||
|
||
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](https://docs.tiledb.io/en/stable/installation.html#conda). | ||
## Documentation | ||
|
||
### Developer Documentation | ||
- [Quickstart](https://docs.tiledb.com/developer/quickstart) | ||
- [Reference Docs](https://tiledb-inc.github.io/TileDB-R/) | ||
|
||
Instructions for setting up a RStudio devlopment environment, building, and testing the TileDB-R package are located in the [developer documentation wiki](https://github.com/TileDB-Inc/TileDB-R/wiki). | ||
|
||
## Compatibility | ||
|
||
|
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.