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.

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

Docs for r, rstudio, and renv installation #178

Merged
merged 19 commits into from
Mar 15, 2024

Conversation

sjspielman
Copy link
Member

@sjspielman sjspielman commented Mar 13, 2024

Which issue does this address?

Closes #126
Closes #127

Briefly describe the scope of the added docs file, including whether you link out to any external docs.

This docs page includes the R, RStudio, and package dependencies (renv + biocmanager) installation instructions. Please let me know any feedback on wording (including headers), organization, and any other recommendations for how to present these instructions.

Will you need additional visual aids for these docs?

No

Any other comments for reviewers?

FYI this is stacked on #169

Author checklist

Reviewer checklist

Please refer to the docs style guide and the docs contributing guide while reviewing this pull request.

@sjspielman
Copy link
Member Author

Inspired by a local spellcheck run, I made a few more changes to contributing.md as well. Let me know if you agree with these changes or not!

@sjspielman sjspielman changed the title Docs for r, rstudio, and renv Docs for r, rstudio, and renv installation Mar 13, 2024
Copy link
Member

@jaclyn-taroni jaclyn-taroni left a comment

Choose a reason for hiding this comment

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

Overall content looks reasonable. I am confused by the use of "Terminal" – I looked at other sections of the built version of the docs and it did not clear anything up for me. Relatedly, I am confused about how we talk about installing additional tools (e.g., FORTRAN compiler), but I actually don't know that we need to say anything beyond you need these things.

@sjspielman
Copy link
Member Author

I am confused about how we talk about installing additional tools (e.g., FORTRAN compiler), but I actually don't know that we need to say anything beyond you need these things.

Is this related to the "Terminal" wording situation, or is there a different confusion? I have removed all the wrong instances of that word!

…emonade/OpenScPCA-analysis into sjspielman/126-127-r-rstudio-renv
Copy link
Member

@jaclyn-taroni jaclyn-taroni left a comment

Choose a reason for hiding this comment

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

👍🏻

Yes, the additional tools confusion was related to the use of "Terminal"

@sjspielman
Copy link
Member Author

Yes, the additional tools confusion was related to the use of "Terminal"

:games:

Base automatically changed from sjspielman/122-conda-setup to main March 15, 2024 13:03
@sjspielman sjspielman merged commit c423f06 into main Mar 15, 2024
3 checks passed
@sjspielman sjspielman deleted the sjspielman/126-127-r-rstudio-renv branch March 15, 2024 13:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Doc: Install R, and R Studio Doc: Setting up renv
2 participants