-
Notifications
You must be signed in to change notification settings - Fork 22
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update R docs and doc-site #684
Conversation
Codecov Report
@@ Coverage Diff @@
## main #684 +/- ##
=======================================
Coverage 87.06% 87.06%
=======================================
Files 65 65
Lines 4493 4493
=======================================
Hits 3912 3912
Misses 581 581
Flags with carried forward coverage won't be shown. Click here to find out more. 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
Just one question, I noticed the new examples are generally using |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A few minor suggestions, but LGTM. Disclaimer: Did not "test" the R instructions and haven't seen the rendered docs.
@@ -29,11 +29,14 @@ If installing in a Databricks notebook environment, use `%pip install`. Do not u | |||
|
|||
## R | |||
|
|||
The R package will be soon deposited into R-Universe. In the meantime you can directly install from github using the [devtools](https://devtools.r-lib.org/) R package. | |||
From an R session, first install `tiledb` from R-Universe, the latest release in CRAN is not yet available. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
From an R session, first install `tiledb` from R-Universe, the latest release in CRAN is not yet available. | |
From an R session, first install `tiledb` from R-Universe, as the latest release in CRAN is not yet available. |
|
||
## Installation | ||
|
||
You can install the development version of `cellxgene.census` from [GitHub](https://github.com/) with: | ||
From an R session, first install `tiledb` from R-Universe, the latest release in CRAN is not yet available. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since this is repeated in online docs, checking that you definitely want to repeat it here rather than linking out? It's not unreasonable, as is.
) | ||
) | ||
|
||
# Continued below |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
necessary?
Co-authored-by: Andrew Tolopko <atolopko-czi@users.noreply.github.com>
Co-authored-by: Andrew Tolopko <atolopko-czi@users.noreply.github.com>
Co-authored-by: Andrew Tolopko <atolopko-czi@users.noreply.github.com>
Co-authored-by: Andrew Tolopko <atolopko-czi@users.noreply.github.com>
api/r/cellxgene.census/README.md
Outdated
```r | ||
install.packages( | ||
"cellxgene.census", | ||
repos=c('https://tiledb-inc.r-universe.dev','https://cloud.r-project.org') |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
repos=c('https://tiledb-inc.r-universe.dev','https://cloud.r-project.org') | |
repos=c('https://chanzuckerberg.r-universe.dev','https://cloud.r-project.org') |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done!
Addresses #670 #668 #669