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

Update demo info for DC R Ecology #1690

Merged
merged 7 commits into from
Jul 10, 2024
Merged

Update demo info for DC R Ecology #1690

merged 7 commits into from
Jul 10, 2024

Conversation

tobyhodges
Copy link
Member

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 datacarpentry/R-ecology-lesson#886 and the blog post linked from there for more context about the lesson redesign

@tobyhodges tobyhodges requested a review from ndporter July 8, 2024 13:09
Copy link

github-actions bot commented Jul 8, 2024

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

⏱️ Updated at 2024-07-10 17:51:23 +0000

Copy link
Contributor

@brownsarahm brownsarahm left a comment

Choose a reason for hiding this comment

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

I think I found a typo (see suggestion) and I think it's worth putting the recommended episode from here in the hw/setup lists.

episodes/12-homework.md Show resolved Hide resolved
learners/demo_lessons.md Outdated Show resolved Hide resolved
github-actions bot pushed a commit that referenced this pull request Jul 9, 2024
github-actions bot pushed a commit that referenced this pull request Jul 9, 2024
learners/demo_lessons.md Show resolved Hide resolved
episodes/12-homework.md Show resolved Hide resolved
@ndporter
Copy link
Contributor

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

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

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.

Copy link
Contributor

@brownsarahm brownsarahm left a comment

Choose a reason for hiding this comment

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

approving the thing I requested changes on.

For people who have already signed up, they can use the demo pad? maybe just a small note like:

this is new, if you signed up for a demo with the old lesson you may complete your demo using the old lesson

github-actions bot pushed a commit that referenced this pull request Jul 10, 2024
github-actions bot pushed a commit that referenced this pull request Jul 10, 2024
@tobyhodges
Copy link
Member Author

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

I think this is ready to go.

github-actions bot pushed a commit that referenced this pull request Jul 10, 2024
@ndporter
Copy link
Contributor

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:

  • I agree that Exploring and Understanding Data is best for teaching practice
  • The ggplot2 one is fine for demos too
  • Working with data depends on downloaded surveys so has the dependencies issues and I would leave it out (not recommend, but not prohibit) in the demos table
  • the new intro should be not eligible

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

learners/demo_lessons.md Outdated Show resolved Hide resolved
@tobyhodges
Copy link
Member Author

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.

github-actions bot pushed a commit that referenced this pull request Jul 10, 2024
Copy link
Contributor

@brownsarahm brownsarahm left a comment

Choose a reason for hiding this comment

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

tiny tiny update to clearly signpost that this is R. but otherwise it all lgtm

episodes/12-homework.md Outdated Show resolved Hide resolved
learners/setup.md Outdated Show resolved Hide resolved
@tobyhodges
Copy link
Member Author

Thanks @brownsarahm and @ndporter

github-actions bot pushed a commit that referenced this pull request Jul 10, 2024
@tobyhodges tobyhodges merged commit d6e1e8b into main Jul 10, 2024
3 checks passed
@tobyhodges tobyhodges deleted the 1683-dc-r-ecology-demos branch July 10, 2024 17:53
github-actions bot pushed a commit that referenced this pull request Jul 10, 2024
Auto-generated via {sandpaper}
Source  : d6e1e8b
Branch  : main
Author  : Toby Hodges <[email protected]>
Time    : 2024-07-10 17:53:43 +0000
Message : Merge pull request #1690 from carpentries/1683-dc-r-ecology-demos

Update demo info for DC R Ecology
github-actions bot pushed a commit that referenced this pull request Jul 10, 2024
Auto-generated via {sandpaper}
Source  : 9d98465
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2024-07-10 17:54:31 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : d6e1e8b
Branch  : main
Author  : Toby Hodges <[email protected]>
Time    : 2024-07-10 17:53:43 +0000
Message : Merge pull request #1690 from carpentries/1683-dc-r-ecology-demos

Update demo info for DC R Ecology
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.

Update Data Carpentry Ecology Suggested episodes for practice and demos
3 participants