Merge pull request #3 from macromeer/update-ggplot2-4

Add tests and CI; move data into data/ and images/

Author: macromeer

.github/workflows/tests.yaml

@@ -0,0 +1,43 @@
+name: tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+
+    steps:
+      - uses: actions/checkout@v7
+
+      # Liberation Sans stands in for Arial; pdffonts checks the fonts embedded in the PDF
+      - name: Install fonts and poppler-utils
+        run: sudo apt-get update && sudo apt-get install -y fonts-liberation poppler-utils
+
+      - uses: r-lib/actions/setup-r@v2
+        with:
+          use-public-rspm: true
+
+      # Installs the packages listed in DESCRIPTION, including system libraries (ImageMagick)
+      - uses: r-lib/actions/setup-r-dependencies@v2
+        with:
+          dependencies: '"all"'
+
+      - name: Run tests
+        run: Rscript -e 'testthat::test_dir("tests/testthat")'
+
+      - name: Upload snapshot differences
+        if: failure()
+        uses: actions/upload-artifact@v7
+        with:
+          name: snapshot-differences
+          path: tests/testthat/_snaps/**/*.new.svg
+          if-no-files-found: ignore

DESCRIPTION

@@ -0,0 +1,25 @@
+Package: scifigexamples
+Title: Scientific Publication Figure Plotting Examples with R
+Version: 0.1.0
+Description: Example script for a multi-panel scientific figure. This is not
+    an R package: the file only lists the dependencies, so they can be
+    installed with pak::local_install_deps() and in CI.
+License: GPL-3
+Encoding: UTF-8
+Depends:
+    R (>= 4.1)
+Imports:
+    ggforce,
+    ggplot2 (>= 3.5.0),
+    grid,
+    latex2exp,
+    magick,
+    patchwork,
+    scales,
+    svglite,
+    systemfonts
+Suggests:
+    testthat (>= 3.0.0),
+    vdiffr,
+    withr
+Config/testthat/edition: 3

README.md

@@ -18,3 +18,30 @@ Rscript figure_example.R
 ```
 
 This writes `figure_example.png`, `figure_example.svg` and `figure_example.pdf`.
+
+## Layout
+
+| Path | Contents |
+|---|---|
+| `figure_example.R` | Script that builds and saves the figure |
+| `data/` | CSV data for panels B–F |
+| `images/` | Microscopy images for panel A |
+| `tests/` | Tests (see below) |
+
+## Tests
+
+The tests check the data loading, that every panel renders without warnings, the exported files, and how each panel looks (visual snapshots with vdiffr). They run on GitHub Actions for every push and pull request. To run them locally:
+
+```r
+install.packages(c("testthat", "vdiffr", "withr"))
+```
+
+```sh
+Rscript -e 'testthat::test_dir("tests/testthat")'
+```
+
+If you change a panel on purpose, the snapshot test for it fails. Review the new version and accept it with:
+
+```r
+testthat::snapshot_review("snapshots", path = "tests/testthat")
+```