Test PR preview

[milanmlft]

Testing sandpaper's built-in PR previews for #12

[!warning] This PR just adds nonsense content and is not supposed to be merged!

[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/HealthBioscienceIDEAS/microscopy-novice/compare/md-outputs..md-outputs-PR-13

The following changes were observed in the rendered markdown documents:

 another-episode.md (new)                         | 116 +++++++++++++++++++++++
 fig/another-episode-rendered-pyramid-1.png (new) | Bin 0 -> 4841 bytes
 introduction.md                                  |  14 +++
 md5sum.txt                                       |  23 ++---
 4 files changed, 142 insertions(+), 11 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-11-09 12:15:36 +0000

[davecash75]

Sorry I'm not sure how I can check the rendered content? I'm just getting the standard diff view of the files between the original and the current branch. Should I be seeing some rendered markdown side by side?

[milanmlft]

Hi @davecash75, sandpaper's PR preview doesn't show the rendered content, only the diff view of the (raw) content that has changed. To see the rendered content, you would have to pull the branch and rebuild locally.

[davecash75]

@milanmlft Do I have to compile sandpaper from the forked repo if I am to build the files locally?

[milanmlft]

@davecash75 Correct! Let me write up some installation instructions (I should probably also add these somewhere more visisble in the repo):

You should be able to run all of these from within R

## Install remotes package
install.packages("remotes")

## Install sandpaper and varnish from the IDEAS forks
remotes::install_github("HealthBioscienceIDEAS/sandpaper", dependencies = TRUE)
remotes::install_github("HealthBioscienceIDEAS/varnish", dependencies = TRUE)

Then to build the lesson locally, from within the microscopy-novice directory, run

sandpaper::build_site()

That should open the built home page in a browser window automatically, but if not, you can find the built HTML files in the site/ directory :)

Let me know if this works!

[davecash75]

I needed a couple of additional dependencies via homebrew for some of the other dependencies, mainly due to missing include files: openssl, harfbuzz, and fribidi. Installing those now and see if the install_github will then finish

[davecash75]

Hi @milanmlft - I'm able to build locally, so I can take a look at @K-Meech 's first episode. I got an error when I tried

sandpaper::build_site()

as it appears to be an internal function when I built it with the remotes::install_github() method. When I looked at the documentation on sandpaper, it seemed to suggest

sandpaper::build_lesson()

[milanmlft]

Oh right, sorry about that! build_lesson() is the correct method 🙂