Skip to content

feat: Add introduction section on reproducible research #11

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

Conversation

matthewfeickert
Copy link
Member

  • Explain what reproducibility means and what is computational reproducibility.
  • Add glossary terms for 'computer platform' and 'computational reproducibility'.

Copy link

github-actions bot commented May 26, 2025

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/reproducible-ml-workflows/compare/md-outputs..md-outputs-PR-11

The following changes were observed in the rendered markdown documents:

 introduction.md | 181 +++++++++++++++++++++++++++++++++++---------------------
 md5sum.txt      |   4 +-
 reference.md    |   8 +++
 3 files changed, 123 insertions(+), 70 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 2025-05-26 16:14:04 +0000

@matthewfeickert
Copy link
Member Author

CI is currently failing given the workflow step

- name: "Check PR"
id: check-pr
uses: carpentries/actions/check-valid-pr@main
with:
pr: ${{ github.event.number }}
invalid: ${{ fromJSON(steps.hash.outputs.json)[github.repository] }}
fail_on_error: true

is broken as described in carpentries/actions#111.

@matthewfeickert matthewfeickert self-assigned this May 26, 2025
@matthewfeickert matthewfeickert force-pushed the feat/add-intro-section branch from 6019880 to 4dc320f Compare May 26, 2025 08:19
@matthewfeickert
Copy link
Member Author

Seems to be a GitHub status issue: carpentries/actions#111 (comment)

@matthewfeickert matthewfeickert force-pushed the feat/add-intro-section branch from 4dc320f to 22f228a Compare May 26, 2025 16:13
@matthewfeickert matthewfeickert marked this pull request as ready for review May 26, 2025 16:13
@matthewfeickert matthewfeickert merged commit b978049 into carpentries-incubator:main May 26, 2025
3 checks passed
github-actions bot pushed a commit that referenced this pull request May 26, 2025
@matthewfeickert matthewfeickert deleted the feat/add-intro-section branch May 26, 2025 16:14
github-actions bot pushed a commit that referenced this pull request May 26, 2025
Auto-generated via `{sandpaper}`
Source  : b978049
Branch  : main
Author  : Matthew Feickert <[email protected]>
Time    : 2025-05-26 16:14:40 +0000
Message : feat: Add introduction section on reproducible research (#11)

* Explain what reproducibility means and what is computational reproducibility.
* Add glossary terms for 'computer platform' and 'computational reproducibility'.
github-actions bot pushed a commit that referenced this pull request May 26, 2025
Auto-generated via `{sandpaper}`
Source  : 3bd4ed5
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2025-05-26 16:15:25 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : b978049
Branch  : main
Author  : Matthew Feickert <[email protected]>
Time    : 2025-05-26 16:14:40 +0000
Message : feat: Add introduction section on reproducible research (#11)

* Explain what reproducibility means and what is computational reproducibility.
* Add glossary terms for 'computer platform' and 'computational reproducibility'.
github-actions bot pushed a commit that referenced this pull request May 27, 2025
Auto-generated via `{sandpaper}`
Source  : 3bd4ed5
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2025-05-26 16:15:25 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : b978049
Branch  : main
Author  : Matthew Feickert <[email protected]>
Time    : 2025-05-26 16:14:40 +0000
Message : feat: Add introduction section on reproducible research (#11)

* Explain what reproducibility means and what is computational reproducibility.
* Add glossary terms for 'computer platform' and 'computational reproducibility'.
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.

1 participant