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

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

Merged
merged 3 commits into from
Apr 16, 2024

Conversation

isaac-jennings
Copy link
Contributor

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.

Add instructor notes for install of ggplot2 package with explicit dependencies flag.
Copy link

github-actions bot commented Dec 6, 2023

Thank you!

Thank you for your pull request 😃

🤖 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:

  • 🎯 correct output
  • 🖼️ correct figures
  • ❓ new warnings
  • ‼️ new errors

Rendered Changes

🔍 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.

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

@naupaka
Copy link
Member

naupaka commented Dec 13, 2023

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")

@@ -705,6 +705,16 @@ install.packages(c("ggplot2", "plyr", "gapminder"))

::::::::::::::::::::::::::::::::::::::::::::::::::

::::::::::::::::::::::::::::::::::::: instructor

When installing ggplot2, it may be required on some users to use the dependencies flag as a result of lazy loading affecting the install. This is an explicit solution to address this bug. Such that:
Copy link
Contributor

Choose a reason for hiding this comment

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

can you add link to the bug?

@@ -705,6 +705,16 @@ install.packages(c("ggplot2", "plyr", "gapminder"))

::::::::::::::::::::::::::::::::::::::::::::::::::

::::::::::::::::::::::::::::::::::::: instructor

When installing ggplot2, it may be required on some users to use the dependencies flag as a result of lazy loading affecting the install. This is an explicit solution to address this bug. Such that:
Copy link
Contributor

Choose a reason for hiding this comment

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

perhaps update wording to "required for some users"

github-actions bot pushed a commit that referenced this pull request Apr 4, 2024
@isaac-jennings
Copy link
Contributor Author

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
Copy link
Member

naupaka commented Apr 12, 2024

@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.

Rephrase of proposed change due to bug not linking to any known or findable discussion threads from the broader R/Posit community.
github-actions bot pushed a commit that referenced this pull request Apr 16, 2024
@isaac-jennings
Copy link
Contributor Author

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

@naupaka
Copy link
Member

naupaka commented Apr 16, 2024

thanks @isaac-jennings!

@naupaka naupaka merged commit fdbbf55 into swcarpentry:main Apr 16, 2024
3 checks passed
github-actions bot pushed a commit that referenced this pull request Apr 16, 2024
Auto-generated via {sandpaper}
Source  : fdbbf55
Branch  : main
Author  : Naupaka Zimmerman <[email protected]>
Time    : 2024-04-16 22:42:17 +0000
Message : Merge pull request #881 from isaac-jennings/main

Proposed Update to package install at 01-rstudio-intro.Rmd
github-actions bot pushed a commit that referenced this pull request Apr 16, 2024
Auto-generated via {sandpaper}
Source  : 953c729
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2024-04-16 22:43:34 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : fdbbf55
Branch  : main
Author  : Naupaka Zimmerman <[email protected]>
Time    : 2024-04-16 22:42:17 +0000
Message : Merge pull request #881 from isaac-jennings/main

Proposed Update to package install at 01-rstudio-intro.Rmd
github-actions bot pushed a commit that referenced this pull request Apr 23, 2024
Auto-generated via {sandpaper}
Source  : 953c729
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2024-04-16 22:43:34 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : fdbbf55
Branch  : main
Author  : Naupaka Zimmerman <[email protected]>
Time    : 2024-04-16 22:42:17 +0000
Message : Merge pull request #881 from isaac-jennings/main

Proposed Update to package install at 01-rstudio-intro.Rmd
github-actions bot pushed a commit that referenced this pull request Apr 30, 2024
Auto-generated via {sandpaper}
Source  : 953c729
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2024-04-16 22:43:34 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : fdbbf55
Branch  : main
Author  : Naupaka Zimmerman <[email protected]>
Time    : 2024-04-16 22:42:17 +0000
Message : Merge pull request #881 from isaac-jennings/main

Proposed Update to package install at 01-rstudio-intro.Rmd
github-actions bot pushed a commit that referenced this pull request May 7, 2024
Auto-generated via {sandpaper}
Source  : 953c729
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2024-04-16 22:43:34 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : fdbbf55
Branch  : main
Author  : Naupaka Zimmerman <[email protected]>
Time    : 2024-04-16 22:42:17 +0000
Message : Merge pull request #881 from isaac-jennings/main

Proposed Update to package install at 01-rstudio-intro.Rmd
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.

3 participants