swcarpentry / r-novice-inflammation

Programming with R
http://swcarpentry.github.io/r-novice-inflammation/
Other
163 stars 395 forks source link

Replace excel screenshots by embedded file contents #598

Closed Bisaloo closed 11 months ago

Bisaloo commented 1 year ago

Fix #434.

This will also be hopefully more accessible for visitors using screenreaders since they can now more easily access the full information that was previously summarized in a terse alt text.

github-actions[bot] commented 1 year ago

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:

Rendered Changes

:mag: Inspect the changes: https://github.com/swcarpentry/r-novice-inflammation/compare/md-outputs..md-outputs-PR-598

The following changes were observed in the rendered markdown documents:

 11-supp-read-write-csv.md   | 43 ++++++++++++++++-----
 data/car-speeds-cleaned.csv | 94 ---------------------------------------------
 md5sum.txt                  |  2 +-
 3 files changed, 35 insertions(+), 104 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 2023-12-02 12:34:39 +0000

Bisaloo commented 11 months ago

I'm still unsure of what would be the best way to do this.

I went with saving only head() of the data. Alternatively, we could truncate the files before reading them with echo = FALSE to not distract the readers from the main point but I'm always wary of doing operations behind the scenes.