datacarpentry / R-ecology-lesson

Data Analysis and Visualization in R for Ecologists
https://datacarpentry.org/R-ecology-lesson/
Other
311 stars 509 forks source link

Formatting changes to episodes #877

Closed klgallagher closed 11 months ago

klgallagher commented 1 year ago

If this pull request addresses an open issue on the repository, please add 'Closes #NN' below, where NN is the issue number.

Closes #865

Please briefly summarise the changes made in the pull request, and the reason(s) for making these changes.

These changes update the formatting for the overview boxes to match the new lesson format. Keypoints and questions were also added to each lesson.

If any relevant discussions have taken place elsewhere, please provide links to these.

The contributors (Katherine Gallagher, Juan Jose Garcia Mesa, and Doug Joubert) communicated with Toby Hodges about the changes and coordinated efforts via the Carpentries Slack.

For more guidance on how to contribute changes to a Carpentries project, please review [the Contributing Guide](CONTRIBUTING.md) and [Code of Conduct](https://docs.carpentries.org/topic_folders/policies/code-of-conduct.html). Please keep in mind that lesson Maintainers are volunteers and it may be some time before they can respond to your contribution. Although not all contributions can be incorporated into the lesson materials, we appreciate your time and effort to improve the curriculum. If you have any questions about the lesson maintenance process or would like to volunteer your time as a contribution reviewer, please contact The Carpentries Team at team@carpentries.org.
github-actions[bot] commented 1 year 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/datacarpentry/R-ecology-lesson/compare/md-outputs..md-outputs-PR-877

The following changes were observed in the rendered markdown documents:

 00-before-we-start.md                              |   50 +-
 01-intro-to-r.md                                   |   22 +-
 02-starting-with-data.md                           |  751 +++++-----
 03-dplyr.md                                        |   28 +-
 04-visualization-ggplot2.md                        |   18 +-
 05-r-and-databases.md                              |   17 +-
 config.yaml (gone)                                 |   86 --
 ...tion-ggplot2-rendered-boxplot-with-points-1.png |  Bin 79363 -> 78848 bytes
 ...ization-ggplot2-rendered-unnamed-chunk-10-1.png |  Bin 97555 -> 97843 bytes
 ...ization-ggplot2-rendered-unnamed-chunk-11-1.png |  Bin 64965 -> 64474 bytes
 ...lization-ggplot2-rendered-unnamed-chunk-9-1.png |  Bin 82545 -> 82434 bytes
 md5sum.txt                                         |   34 +-
 renv.lock (gone)                                   | 1581 --------------------
 13 files changed, 518 insertions(+), 2069 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 2023-10-20 08:21:37 +0000

ErinBecker commented 11 months ago

Thank you for these contributions @klgallagher (and Juan and Doug)! These are a major improvement to the lesson and bring it up to date with much of the formatting requirements necessary for the change over from the old lesson template (which was unique for this lesson) to the new Workbench styling.