-
-
Notifications
You must be signed in to change notification settings - Fork 112
Improving variable names in the entire lesson #495
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
Conversation
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:
Rendered Changes🔍 Inspect the changes: https://github.com/datacarpentry/r-raster-vector-geospatial/compare/md-outputs..md-outputs-PR-495 The following changes were observed in the rendered markdown documents:
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 2025-08-22 21:02:48 +0000 |
This PR will close several issues and be a numbered release for the Lesson, which will be archived in Zenodo. |
Auto-generated via `{sandpaper}` Source : 15caca8 Branch : md-outputs Author : GitHub Actions <actions@github.com> Time : 2025-10-06 19:29:07 +0000 Message : markdown source builds Auto-generated via `{sandpaper}` Source : 31bfcb4 Branch : main Author : Jon Jablonski <jonjab@ucsb.edu> Time : 2025-10-06 19:00:29 +0000 Message : Merge pull request #495 from UCSBCarpentry/main Improving variable names in the entire lesson
Auto-generated via `{sandpaper}` Source : 15caca8 Branch : md-outputs Author : GitHub Actions <actions@github.com> Time : 2025-10-06 19:29:07 +0000 Message : markdown source builds Auto-generated via `{sandpaper}` Source : 31bfcb4 Branch : main Author : Jon Jablonski <jonjab@ucsb.edu> Time : 2025-10-06 19:00:29 +0000 Message : Merge pull request #495 from UCSBCarpentry/main Improving variable names in the entire lesson
Auto-generated via `{sandpaper}` Source : 15caca8 Branch : md-outputs Author : GitHub Actions <actions@github.com> Time : 2025-10-06 19:29:07 +0000 Message : markdown source builds Auto-generated via `{sandpaper}` Source : 31bfcb4 Branch : main Author : Jon Jablonski <jonjab@ucsb.edu> Time : 2025-10-06 19:00:29 +0000 Message : Merge pull request #495 from UCSBCarpentry/main Improving variable names in the entire lesson
If this pull request addresses an open issue on the repository, please add 'Closes #NN' below, where NN is the issue number.
Closes #484, closes #302
Please briefly summarise the changes made in the pull request, and the reason(s) for making these changes.
Based on #484, and specifically this comment, changes were made in all .Rmd files inside the episodes/ directory to improve variable names following best practices: not using dots, use snake_case, and overall making them consistent across episodes.
To make sure I didn't break any part of the lesson, I compared side-by-side the current rendered lesson and my local rendered version with the name changes and made sure that everything was ok. It was relatively simple, as the Rmd integration let me know if there was an error in a code chunk or graph. And I made sure all the outputs of the code chunks (including plots) were being generated correctly in the rendered version of my changes.
The idea is that this PR is merged when the lesson is not being actively taught, which to our knowledge will be on Sept 2.
I preview of how the changes look like is here https://carpentry.library.ucsb.edu/r-raster-vector-geospatial/, if you'd like to also compare side-by-side
Here is a complete list of the 84 variable names that were changed, written in the format old_variable_name -> new_variable_name: