Skip to content

Commit

Permalink
Merge 298d27a into bde7c23
Browse files Browse the repository at this point in the history
  • Loading branch information
mlin authored Jun 23, 2023
2 parents bde7c23 + 298d27a commit a6c7147
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions apis/r/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ Please also see the `main-old` branch for an implementation of the [original spe

# Installation

## Using R-universe
## Release packages

TileDB-SOMA is available on R-universe and [Conda](https://anaconda.org/tiledb/r-tiledbsoma), and can be installed directly from R or `mambda` as indicated below.
TileDB-SOMA releases are available on R-universe and [Conda](https://anaconda.org/tiledb/r-tiledbsoma), and can be installed directly from R or `mamba` as indicated below.

```r
install.packages('tiledbsoma', repos = c('https://tiledb-inc.r-universe.dev',
install.packages('tiledbsoma', repos = c('https://chanzuckerberg.r-universe.dev',
'https://cloud.r-project.org'))
```

Expand All @@ -22,6 +22,12 @@ mamba install -c conda-forge -c tiledb r-tiledbsoma

## From source

To install the very latest tiledbsoma development version (our `main` branch), use [`remotes::install_github()`](https://cran.r-project.org/web/packages/remotes/readme/README.html):

```r
remotes::install_github("https://github.com/single-cell-data/TileDB-SOMA", subdir="apis/r")
```

### Requirements

* Source installation requires the [`tiledb` R package](https://github.com/TileDB-Inc/TileDB-R) -- which in turn depends on either a local installation of [TileDB Core library](https://github.com/TileDB-Inc/TileDB) or the provided build artifacts.
Expand All @@ -31,7 +37,9 @@ mamba install -c conda-forge -c tiledb r-tiledbsoma
* In addition, this R package also depends on the [`libtiledbsoma` library](https://github.com/single-cell-data/TileDB-SOMA/tree/main/libtiledbsoma) from this repository. It is either installed with the package (as described in the next section), or can be used as a system library (if one is found). A system installation can be provided by following the steps in the [`libtiledbsoma` directory](https://github.com/single-cell-data/TileDB-SOMA/tree/main/libtiledbsoma).


### Step-by-step
### Development setup

To set up & install from a local clone of this git repository:

* Clone this repository: `git clone https://github.com/single-cell-data/TileDB-SOMA.git`.
* Change into the R API package directory: `cd TileDB-SOMA/apis/r`.
Expand Down

0 comments on commit a6c7147

Please sign in to comment.