Instructor notes

[juanfung]

Closes #476

Adds

• Suggested lesson plans to instructor notes
• Summary of "Introduction to R" episode in the Narrative section
• "Data" section moved to beginning of Narrative

FYI: Accidentally cited #477 in commits.

For more guidance on how to contribute changes to a Carpentries project, please review the Contributing Guide and Code of Conduct.

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 [email protected].

[github-actions]

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/datacarpentry/r-socialsci/compare/md-outputs..md-outputs-PR-488

The following changes were observed in the rendered markdown documents:

 00-intro.md                                        |  12 ++++
 01-intro-to-r.md                                   |  10 ++++
 02-starting-with-data.md                           |  26 +++++++--
 03-dplyr.md                                        |  10 ++++
 05-ggplot2.md                                      |   8 +++
 06-rmarkdown.md                                    |  10 +++-
 07-json.md                                         |   9 +++
 fig/05-ggplot2-rendered-adding-colors-1.png        | Bin 17690 -> 17707 bytes
 fig/05-ggplot2-rendered-adding-jitter-1.png        | Bin 9196 -> 8973 bytes
 fig/05-ggplot2-rendered-adding-width-height-1.png  | Bin 8825 -> 8744 bytes
 fig/05-ggplot2-rendered-boxplot-exercise-1.png     | Bin 10245 -> 10276 bytes
 ...-ggplot2-rendered-boxplot-exercise-factor-1.png | Bin 21609 -> 21312 bytes
 fig/05-ggplot2-rendered-boxplot-with-jitter-1.png  | Bin 16780 -> 16578 bytes
 fig/05-ggplot2-rendered-color-by-species-1.png     | Bin 19188 -> 19353 bytes
 fig/05-ggplot2-rendered-scatter-challenge-1.png    | Bin 18444 -> 18660 bytes
 fig/05-ggplot2-rendered-violin-plot-1.png          | Bin 27793 -> 28207 bytes
 index.md                                           |  10 +++-
 instructor-notes.md                                |  61 ++++++---------------
 md5sum.txt                                         |  18 +++---
 19 files changed, 110 insertions(+), 64 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 2023-10-12 18:16:04 +0000

[juanfung]

@jessesadler 🚀

[jessesadler]

I noted one change to make in the index.md file where a url is written twice. Otherwise the content looks good. However, I was looking over the Workbench material and figured out why the Instructor notes page has headings for all of the lessons at the bottom of the page. It looks like the preferred method is to put episode specific notes in that episode within an instructor div. See here https://carpentries.github.io/workbench/transition-guide.html#instructor-notes. I think it would be a good idea to do this. Just moving what we have here to the individual episodes at the top of the document. A benefit of this is that within the instructor view the instructor notes are visible within the episode instead of on an external page. Let me know what you think @juanfung. I am also happy to do it, if you approve, if you do not have the time right now.

[jessesadler]

The link to the instructor notes is put in twice, once in the markdown link and once outside it. Delete the second instance.

[juanfung]

@jessesadler great catch! Also, thank you for looking into the episode heading thing.

[juanfung]

@juanfung Reminder

• Move narrative episode summaries from instructor notes to each respective episode

[juanfung]

@jessesadler revised

[jessesadler]

Looks good!