swcarpentry / r-novice-gapminder

R for Reproducible Scientific Analysis
http://swcarpentry.github.io/r-novice-gapminder/
Other
164 stars 536 forks source link

Proposed Update to package install at 01-rstudio-intro.Rmd #881

Closed isaac-jennings closed 5 months ago

isaac-jennings commented 9 months ago

Dear maintainers,

This PR follows from a closed PR found at #868 . As per advice from the maintainer team, I have added the proposed update via an instructor note.

I am a SWC Instructor who regularly delivers this R workshop to researchers. Over the course of many workshops in 2023, there have been recurrent issues in relation to lazy loading, and dependency install failure when installing ggplot2 on some machines. 9/10 times, setting the dependencies flag to TRUE explicitly tends to resolve the issues encountered. The other 1/10 times are often new R users setting the library download location to a sync folder i.e. cloud storage (in my experience at least).

For your consideration, and best wishes.

github-actions[bot] commented 9 months ago

Thank you!

Thank you for your pull request :smiley:

:robot: This automated message can help you check the rendered files in your submission for clarity. If you have any questions, please feel free to open an issue in {sandpaper}.

If you have files that automatically render output (e.g. R Markdown), then you should check for the following:

Rendered Changes

:mag: Inspect the changes: https://github.com/swcarpentry/r-novice-gapminder/compare/md-outputs..md-outputs-PR-881

The following changes were observed in the rendered markdown documents:

 01-rstudio-intro.md | 13 ++++++++++++-
 md5sum.txt          |  2 +-
 2 files changed, 13 insertions(+), 2 deletions(-)
What does this mean? If you have source files that require output and figures to be generated (e.g. R Markdown), then it is important to make sure the generated figures and output are reproducible. This output provides a way for you to inspect the output in a diff-friendly manner so that it's easy to see the changes that occur due to new software versions or randomisation.

:stopwatch: Updated at 2024-04-16 01:10:46 +0000

naupaka commented 9 months ago

Automated checks failing due to

Duplicate chunk label 'ch5-sol', which has been used for the chunk:
install.packages("ggplot2")
install.packages("plyr")
install.packages("gapminder")
isaac-jennings commented 5 months ago

Hi @naupaka, I adjusted the PR file to 1++ one up the solution number. I have only now realised there is no "ch5-sol1" as the original was renamed to "ch5-sol2". Would it be preferred to 1-- one down the solution notations?

naupaka commented 5 months ago

@isaac-jennings I think it's fine to leave the numbering as is -- the previous issue was just that there was a duplicate chunk name. Your adjustment resolves that.

Thanks for the language adjustment based on @skanwal's suggestion. Is there a link or reference to the idea that the installation issue is a bug? If not we may want to word it a little differently.

isaac-jennings commented 5 months ago

Hi @naupaka, I have reworded as there is no known or finable discussion on this as a formal bug.

naupaka commented 5 months ago

thanks @isaac-jennings!