Skip to content

Commit

Permalink
add screenshots folder AND a track on how to use it
Browse files Browse the repository at this point in the history
  • Loading branch information
federicomarini committed Mar 15, 2024
1 parent 14af5b1 commit 955ac31
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions vignettes/screenshots/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Vignette screenshots

This folder contains the screenshots of the app, generated in a pseudo-automated manner - one that does not involve too much of cropping, resizing, and customizing resolution.

The way it works:

```
app <- iSEE(sce, initial) # as in the vignette chunk
```

Once you created the `app` object, call `appshot()` from the `webshot2` package

```
webshot2::appshot(app, file = "screenshots/app_snapped.png", delay = 20)
```

The use of the delay parameter is to ensure that the app has loaded all the panels correctly.

Then, in the vignette, we simply use `knitr::include_graphics()` to embed the images as we normally would.

0 comments on commit 955ac31

Please sign in to comment.