01 - Add discussion, exercise

[SJaffa]

Added an icebreaker discussion (although that might be better in the course intro lesson) and some exercises to get people thinking about how FAIR principles applies to their own work

[github-actions[bot]]

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:

• :dart: correct output
• :framed_picture: correct figures
• :question: new warnings
• :bangbang: new errors

Rendered Changes

:mag: Inspect the changes: https://github.com/carpentries-incubator/fair-research-software/compare/md-outputs..md-outputs-PR-23

The following changes were observed in the rendered markdown documents:

 01-fair-research-software.md | 24 +++++++++++++++++++++++-
 md5sum.txt                   |  2 +-
 2 files changed, 24 insertions(+), 2 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-03-01 16:01:53 +0000

[anenadic]

I like these icebreaker discussions - as you say they may be suitable at the intro to the course episode (I made a PR: https://github.com/carpentries-incubator/fair-research-software/pull/22 for that) during jargon busting. Similarly, you may want to move the last section of the intro episode (called "FAIR software") into your first episode). Let's have a chat about this later today and make a decision and then move things around accordingly.

[anenadic]

New structure:

1. Start episode 01 with an icebreaker - why are you here, what you want to improve, what does FAIR mean to you.
2. Move "FAIR software" from episode 00.
3. Finish episode 01 off with "Software and data used in this course" from episode 00.

[anenadic]

The FAIR list:

• Findable
  • Create a description of your software
  • Place your software in a software repository (and ideally register it in a software registry)
  • Use a unique and persistent identifier for your software (also useful for citations)
• Accessible
  • Make sure people can download your software
• Interoperable
  • Explain the functionality of your software
  • Use standard formats for inputs and outputs
  • Communicate with other software via standard protocols and APIs
• Reusable
  • Document your software (including its functionality, and how to install and run it)
  • Follow best practices for software development (including coding conventions, code readability and verifying its correctness)
  • Give a licence to your software clearly stating how it can be reused
  • State how to cite your software

Expand "accessibility" a bit to include readability (does it make sense once you got it). Expand "reusability" to include being able to run the code on different platforms/operating systems (which is mentioned in the paragraph above the list).