Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Update R docs and doc-site #684

Merged
merged 16 commits into from
Aug 4, 2023
Merged

Update R docs and doc-site #684

merged 16 commits into from
Aug 4, 2023

Conversation

pablo-gar
Copy link
Contributor

Addresses #670 #668 #669

@pablo-gar pablo-gar changed the title Update R docs [DO NOT MERGE] Update R docs Aug 2, 2023
@codecov
Copy link

codecov bot commented Aug 2, 2023 •
edited
Loading

Codecov Report

Merging #684 (39eda12) into main (fcacb33) will not change coverage.
Report is 2 commits behind head on main.
The diff coverage is n/a.

❗ Current head 39eda12 differs from pull request most recent head 200f361. Consider uploading reports for the commit 200f361 to get more accurate results

@@           Coverage Diff           @@
##             main     #684   +/-   ##
=======================================
  Coverage   87.06%   87.06%           
=======================================
  Files          65       65           
  Lines        4493     4493           
=======================================
  Hits         3912     3912           
  Misses        581      581
Flag Coverage Δ
unittests 87.06% <ø> (ø)

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

@pablo-gar pablo-gar changed the title [DO NOT MERGE] Update R docs Update R docs and doc-site Aug 3, 2023
@pablo-gar pablo-gar marked this pull request as ready for review August 3, 2023 20:24
@mlin
Copy link
Contributor

mlin commented Aug 3, 2023

Just one question, I noticed the new examples are generally using a = b rather than the more-frequently-seen a <- b for assignment. I don't feel strongly, but just checking it's intentional? (LGTM otherwise)

atolopko-czi
atolopko-czi approved these changes Aug 3, 2023
View reviewed changes
Copy link
Collaborator

@atolopko-czi atolopko-czi left a 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.

api/r/cellxgene.census/README.md Show resolved Hide resolved
api/r/cellxgene.census/README.md Outdated Show resolved Hide resolved
api/r/cellxgene.census/README.md Outdated Show resolved Hide resolved
docs/cellxgene_census_docsite_installation.md
@@ -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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.

api/r/cellxgene.census/README.md

## 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.
Copy link
Collaborator

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.

docs/cellxgene_census_docsite_quick_start.md Outdated Show resolved Hide resolved
docs/cellxgene_census_docsite_quick_start.md
)
)

# Continued below
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

necessary?

pablo-gar and others added 6 commits August 3, 2023 14:40
@pablo-gar @atolopko-czi
Update api/r/cellxgene.census/README.md
c109498 
Co-authored-by: Andrew Tolopko <atolopko-czi@users.noreply.github.com>
@pablo-gar @atolopko-czi
Update api/r/cellxgene.census/README.md
5a8b79a 
Co-authored-by: Andrew Tolopko <atolopko-czi@users.noreply.github.com>
@pablo-gar @atolopko-czi
Update api/r/cellxgene.census/README.md
1428d58 
Co-authored-by: Andrew Tolopko <atolopko-czi@users.noreply.github.com>
@pablo-gar @atolopko-czi
Update docs/cellxgene_census_docsite_quick_start.md
94f3db8 
Co-authored-by: Andrew Tolopko <atolopko-czi@users.noreply.github.com>
@pablo-gar
Replace '=' with '<-'
7ce53c4
@pablo-gar
Update install instructions
b1f3051
mlin
mlin requested changes Aug 4, 2023
View reviewed changes
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')
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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')

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done!

@pablo-gar pablo-gar mentioned this pull request Aug 4, 2023
Closed
10 tasks
@pablo-gar pablo-gar requested a review from mlin August 4, 2023 17:47
@pablo-gar pablo-gar merged commit 7e614a2 into main Aug 4, 2023
11 checks passed
@pablo-gar pablo-gar deleted the pablo-gar/update-r-docs branch August 4, 2023 20:26
This was referenced Aug 6, 2023
Closed
Closed
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mlin mlin mlin approved these changes

@atolopko-czi atolopko-czi atolopko-czi approved these changes

@ebezzi ebezzi Awaiting requested review from ebezzi

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@pablo-gar @mlin @atolopko-czi