Minimal reproducible code draft

[kaijagahm]

Full draft of the minimal reproducible code lesson. Includes full lesson structure.

Notes:

• I dumped a giant script at the beginning that includes the code in the researcher narrative up through the part that was assigned to this episode. I realize this is overwhelming and gross, and we can discuss changes to it.

  • @peterlaurin and I discussed this today and thought that it was generally a good approach, rather than trying to work the code in gradually, since we're not actually trying to teach coding in this episode. I still have some reservations, but let's roll with it for now.
  • I wanted to use code folding, and tried to, but it didn't work. Asking in Carpentries Slack about how to fix this. If we can't get it to work, we should include this as a separate script that users have to download.
  • I do think it's important to have them all working with the exact same script version at least for this part.

• Critically, this is still missing content for the exercises, and that's largely because the script itself does not contain enough errors. Need to introduce some errors into the script, especially in the later portions (modeling, plotting, answering research questions) so that we can then refer to those in the lesson.

• Time estimates are probably way off.

• @peterlaurin and @xortizross there are some spots indicated here for you to add references back to your own episodes

[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/carpentries-incubator/R-help-reprexes/compare/md-outputs..md-outputs-PR-73

The following changes were observed in the rendered markdown documents:

 4-minimal-reproducible-data.md |  62 +++---
 5-minimal-reproducible-code.md | 434 ++++++++++++++++++++++++++++++++++++++++-
 6-asking-your-question.md      |   8 +-
 md5sum.txt                     |   8 +-
 4 files changed, 466 insertions(+), 46 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-11-23 01:36:51 +0000

[peterlaurin]

Looks good -- I did not check all the renv stuff but it seems to be passing the checks so I think we can just let it be?