[r] Update README.md installation instructions in preparation for 1.0[rc] #1502
Conversation
mlin
added
documentation
Codecov ReportPatch coverage has no change and project coverage change:
❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more. Additional details and impacted files@@ Coverage Diff @@
## main #1502 +/- ##
===========================================
- Coverage 64.67% 53.01% -11.67%
===========================================
Files 102 72 -30
Lines 8346 5825 -2521
===========================================
- Hits 5398 3088 -2310
+ Misses 2948 2737 -211
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
You could add this. That is no differet from us one adding tiledb-some so that census loads -- that took us from one entry |
apis/r/README.md
Outdated
| @@ -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 [`devtools::install_github()`](https://cran.r-project.org/web/packages/githubinstall/vignettes/githubinstall.html): | |||
There was a problem hiding this comment.
devtools is midly deprecated (and pulls in too much other stuff), suggest to use remotes::install_github() which is a little narrower.
apis/r/README.md
Outdated
|
|
||
| ```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')) | ||
| ``` |
There was a problem hiding this comment.
It may make sense to mention that r-universe has macOS binaries (as well as Ubuntu jammy for R 4.3.1). It would have windows binaries if we built for Windows.
Conda/mamba exists to and for multiple architectures but users who are "mostly R users" (and are not also Python users in corporate settings) generally do not do conda.
apis/r/README.md
Outdated
| To install the very latest tiledbsoma development version (our `main` branch), use [`devtools::install_github()`](https://cran.r-project.org/web/packages/githubinstall/vignettes/githubinstall.html): | ||
|
|
||
| ```r | ||
| devtools::install_github("https://github.com/single-cell-data/TileDB-SOMA", subdir="apis/r") |
There was a problem hiding this comment.
remotes::install_github()
Change above-the-fold installation instructions to use chanzuckerberg R-universe (which serves the latest GitHub Release of tiledbsoma) instead of TileDB-Inc (which serves the head ofmain). As agreed in [r] Enumeration of Pros and Cons and different options to provide builds of the R tiledbsoma package #1427install_github()instruction for users who do desire the head ofmainNote: the chanzuckerberg R-universe serves tiledbsoma but not TileDB-R. Users following the instructions in a fresh environment will get the GitHub-Released version of tiledbsoma, and the CRAN version of tiledb. Consequently, to release tiledbsoma we must ensure any necessary changes to TileDB-R have made it out to CRAN. (We do plan to publish tiledbsoma on CRAN once ready, so this just pulls that constraint forward a bit.)