carpentries / instructor-training

Instructor Training
https://carpentries.github.io/instructor-training/
Other
175 stars 289 forks source link

Update demo info for DC R Ecology #1690

Closed tobyhodges closed 4 months ago

tobyhodges commented 4 months ago

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

Closes #1683

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

  1. Adjusts the list of recommended and ineligible episodes for the Data Carpentry Data Analysis and Visualization in R for Ecologists lesson, which has just undergone a major update.
  2. I also removed the links to a part of the previous version of this lesson as a recommended episode for trainees to prepare with as part of the homework before teaching demo activities. If you prefer, we could discuss replacing this with a different episode from the redesigned lesson, instead of removing it altogether.

See https://github.com/datacarpentry/R-ecology-lesson/issues/886 and the blog post linked from there for more context about the lesson redesign

github-actions[bot] commented 4 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/carpentries/instructor-training/compare/md-outputs..md-outputs-PR-1690

The following changes were observed in the rendered markdown documents:

 12-homework.md  |  2 +-
 demo_lessons.md | 11 ++++++++++-
 md5sum.txt      |  6 +++---
 setup.md        |  2 +-
 4 files changed, 15 insertions(+), 6 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-07-10 17:51:23 +0000

ndporter commented 4 months ago

@tobyhodges should we also add a temporary flag on the teaching demo episodes page (either in the table or the header) with information on older versions for people who already started preparing their teaching demos? We could queue another PR that removes the flag/warning in a month or something.

tobyhodges commented 4 months ago

Happy to add that if you feel it's necessary, @ndporter. The goal of adding notices to the lesson landing page and repository was to raise awareness of these changes before they took place, but it may still be necessary to give folks a heads-up after the fact.

ndporter commented 4 months ago

Happy to add that if you feel it's necessary, @ndporter. The goal of adding notices to the lesson landing page and repository was to raise awareness of these changes before they took place, but it may still be necessary to give folks a heads-up after the fact.

It's only for the teaching demos and mostly for people who already did their training but haven't done demos (as well as for the trainers leading the demo sessions) so we make sure everyone is (literally) on the same page as far as what episode/lesson is being used.

tobyhodges commented 4 months ago

Combining these two comments from @ndporter, above:

I feel like the Manipulating data episode is less likely than the ggplot2 one to result in people no getting to any output in their 3 minute practice teaching.

and

I also believe (though it should be checked) that none of the episodes actually have dependencies on previously created data (e.g. they only depend on original data and packages), so we may be able to remove the note on "other episodes".

I have changed my mind and think the Exploring and understanding data episode is the best starting point for teaching demos. The episode begins with library(ratdat), which loads in the complete_old data frame used in the content, and should offer more opportunity for trainees to get into some live coding within their five/three minutes. I will update the PR accordingly.

tobyhodges commented 4 months ago

I think this is ready to go.

ndporter commented 4 months ago

Things make way more sense now. I was looking at a cached copy in my browser of the lesson and so it was actually the previous version. Now that I have the right one:

Sorry for getting confused, though I think it will work out better in the end now.

tobyhodges commented 4 months ago

I have added a note next to each of the demo signups that included an episode from the previous version of the lesson. I will also send emails to each of those trainees so that they are definitely aware.

tobyhodges commented 4 months ago

Thanks @brownsarahm and @ndporter