Merge pull request #82 from nutriverse/dev

update README

.github/workflows/R-CMD-check.yaml

@@ -29,7 +29,7 @@ jobs:
       R_KEEP_PKG_SOURCE: yes
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - uses: r-lib/actions/setup-pandoc@v2
 
@@ -47,3 +47,4 @@ jobs:
       - uses: r-lib/actions/check-r-package@v2
         with:
           upload-snapshots: true
+          build_args: 'c("--no-manual","--compact-vignettes=gs+qpdf")'

.github/workflows/pkgdown.yaml

@@ -0,0 +1,48 @@
+# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
+# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: [main, master]
+  release:
+    types: [published]
+  workflow_dispatch:
+
+name: pkgdown
+
+jobs:
+  pkgdown:
+    runs-on: ubuntu-latest
+    # Only restrict concurrency for non-PR jobs
+    concurrency:
+      group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }}
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: r-lib/actions/setup-pandoc@v2
+
+      - uses: r-lib/actions/setup-r@v2
+        with:
+          use-public-rspm: true
+
+      - uses: r-lib/actions/setup-r-dependencies@v2
+        with:
+          extra-packages: any::pkgdown, local::.
+          needs: website
+
+      - name: Build site
+        run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE)
+        shell: Rscript {0}
+
+      - name: Deploy to GitHub pages 🚀
+        if: github.event_name != 'pull_request'
+        uses: JamesIves/[email protected]
+        with:
+          clean: false
+          branch: gh-pages
+          folder: docs

.github/workflows/test-coverage.yaml

@@ -15,7 +15,7 @@ jobs:
       GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - uses: r-lib/actions/setup-r@v2
         with:
@@ -31,20 +31,20 @@ jobs:
           covr::codecov(
             quiet = FALSE,
             clean = FALSE,
-            install_path = file.path(Sys.getenv("RUNNER_TEMP"), "package")
+            install_path = file.path(normalizePath(Sys.getenv("RUNNER_TEMP"), winslash = "/"), "package")
           )
         shell: Rscript {0}
 
       - name: Show testthat output
         if: always()
         run: |
           ## --------------------------------------------------------------------
-          find ${{ runner.temp }}/package -name 'testthat.Rout*' -exec cat '{}' \; || true
+          find '${{ runner.temp }}/package' -name 'testthat.Rout*' -exec cat '{}' \; || true
         shell: bash
 
       - name: Upload test results
         if: failure()
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: coverage-test-failures
           path: ${{ runner.temp }}/package

DESCRIPTION

@@ -37,7 +37,7 @@ Encoding: UTF-8
 Language: en-GB
 LazyData: true
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.2.3
+RoxygenNote: 7.3.1
 VignetteBuilder: knitr
 URL: https://nutriverse.io/squeacr/, https://github.com/nutriverse/squeacr
 BugReports: https://github.com/nutriverse/squeacr/issues

README.Rmd

@@ -29,13 +29,13 @@ In the recent past, measurement of coverage has been mainly through two-stage cl
 
 ## Installation
 
-The `squeacr` package is not yet available on [CRAN](https://cran.r-project.org). 
-
-The development version of `squeacr` can be installed via [GitHub](https://github.com/nutriverse/squeacr) as follows:
+The `squeacr` package is not yet available on [CRAN](https://cran.r-project.org) but can be installed from the [Nutriverse R universe](https://nutriverse.r-universe.dev) as follows:
 
 ```{r install, echo = TRUE, eval = FALSE}
-if(!require(remotes)) install.packages("remotes")
-remotes::install_github("nutriverse/squeacr")
+install.packages(
+  "squeacr",
+  repos = c('https://nutriverse.r-universe.dev', 'https://cloud.r-project.org')
+)
 ```
 
 ## What does `squeacr` do?

README.md

@@ -33,14 +33,14 @@ conducting a SQUEAC investigation.
 ## Installation
 
 The `squeacr` package is not yet available on
-[CRAN](https://cran.r-project.org).
-
-The development version of `squeacr` can be installed via
-[GitHub](https://github.com/nutriverse/squeacr) as follows:
+[CRAN](https://cran.r-project.org) but can be installed from the
+[Nutriverse R universe](https://nutriverse.r-universe.dev) as follows:
 
 ``` r
-if(!require(remotes)) install.packages("remotes")
-remotes::install_github("nutriverse/squeacr")
+install.packages(
+  "squeacr",
+  repos = c('https://nutriverse.r-universe.dev', 'https://cloud.r-project.org')
+)
 ```
 
 ## What does `squeacr` do?
@@ -64,7 +64,6 @@ follows:
 
 ``` r
 citation("squeacr")
-#> 
 #> To cite squeacr in publications use:
 #> 
 #>   Ernest Guevarra (2023). squeacr: Semi-Quantitative Evaluation of