Merge branch 'update_description' into 'main'

adjust description

See merge request lpjml/lpjmlstats!14

.buildlibrary

@@ -1,4 +1,4 @@
-ValidationKey: '437184'
+ValidationKey: '457378'
 AutocreateReadme: yes
 AcceptedWarnings:
 - 'Warning: package ''.*'' was built under R version'

.github/workflows/check.yaml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - uses: r-lib/actions/setup-pandoc@v2
 
@@ -35,7 +35,7 @@ jobs:
           # gms, goxygen, GDPuc) will usually have an outdated binary version
           # available; by using extra-packages we get the newest version
 
-      - uses: actions/setup-python@v4
+      - uses: actions/setup-python@v5
         with:
           python-version: 3.9
 
@@ -48,6 +48,11 @@ jobs:
         shell: Rscript {0}
         run: lucode2:::validkey(stopIfInvalid = TRUE)
 
+      - name: Verify that lucode2::buildLibrary was successful
+        if: github.event_name == 'pull_request'
+        shell: Rscript {0}
+        run: lucode2:::isVersionUpdated()
+
       - name: Checks
         shell: Rscript {0}
         run: |
@@ -56,6 +61,8 @@ jobs:
 
       - name: Test coverage
         shell: Rscript {0}
-        run: covr::codecov(quiet = FALSE)
+        run: |
+          nonDummyTests <- setdiff(list.files("./tests/testthat/"), c("test-dummy.R", "_snaps"))
+          if(length(nonDummyTests) > 0) covr::codecov(quiet = FALSE)
         env:
           NOT_CRAN: "true"

.pre-commit-config.yaml

@@ -3,7 +3,7 @@
 exclude: '^tests/testthat/_snaps/.*$'
 repos:
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: 2c9f875913ee60ca25ce70243dc24d5b6415598c  # frozen: v4.6.0
     hooks:
     -   id: check-case-conflict
     -   id: check-json
@@ -15,7 +15,7 @@ repos:
     -   id: mixed-line-ending
 
 -   repo: https://github.com/lorenzwalthert/precommit
-    rev: v0.3.2.9019
+    rev: 7910e0323d7213f34275a7a562b9ef0fde8ce1b9  # frozen: v0.4.2
     hooks:
     -   id: parsable-R
     -   id: deps-in-desc

CITATION.cff

@@ -2,8 +2,8 @@ cff-version: 1.2.0
 message: If you use this software, please cite it using the metadata from this file.
 type: software
 title: 'lpjmlstats: Statistical tools for LPJmL data analysis'
-version: 0.2.2
-date-released: '2024-05-29'
+version: 0.2.3
+date-released: '2024-06-12'
 abstract: This package provides statistical tools for LPJmL data analysis to be used
   for benchmarking LPJmL outputs.
 authors:
@@ -13,5 +13,7 @@ authors:
 - family-names: Breier
   given-names: Jannes
   email: [email protected]
+  orcid: 0000-0002-9055-6904
 license: AGPL-3.0
+repository-code: https://github.com/PIK-LPJmL/lpjmlstats
 

DESCRIPTION

@@ -1,14 +1,18 @@
 Package: lpjmlstats
 Title: Statistical tools for LPJmL data analysis
-Version: 0.2.2
-Authors@R: c(person("David","Hötten", email = "[email protected]", role = c("aut", "cre")),
-             person("Jannes","Breier", email = "[email protected]", role = c("aut")))
+Version: 0.2.3
+Authors@R: c(
+    person("David","Hötten", , "[email protected]", role = c("aut", "cre")),
+    person("Jannes","Breier", , "[email protected]", role = c("aut"), comment = c(ORCID = "0000-0002-9055-6904"))
+  )
 Description: This package provides statistical tools for LPJmL data analysis
     to be used for benchmarking LPJmL outputs.
 License: AGPL-3
-Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
 RoxygenNote: 7.3.1
+Encoding: UTF-8
+URL: https://github.com/PIK-LPJmL/lpjmlstats
+BugReports: https://github.com/PIK-LPJmL/lpjmlstats/issues
 Imports:
     dplyr,
     units,
@@ -38,4 +42,4 @@ Config/testthat/edition: 3
 VignetteBuilder: knitr
 Depends:
     R (>= 3.5.0)
-Date: 2024-05-29
+Date: 2024-06-12

README.md

@@ -1,8 +1,8 @@
 # Statistical tools for LPJmL data analysis
 
-R package **lpjmlstats**, version **0.2.2**
+R package **lpjmlstats**, version **0.2.3**
 
-[![CRAN status](https://www.r-pkg.org/badges/version/lpjmlstats)](https://cran.r-project.org/package=lpjmlstats)  [![R build status](https://gitlab.pik-potsdam.de/lpjml/lpjmlstats/workflows/check/badge.svg)](https://gitlab.pik-potsdam.de/lpjml/lpjmlstats/actions) [![codecov](https://codecov.io/gh/lpjml/lpjmlstats/branch/master/graph/badge.svg)](https://app.codecov.io/gh/lpjml/lpjmlstats) [![r-universe](https://pik-piam.r-universe.dev/badges/lpjmlstats)](https://pik-piam.r-universe.dev/builds)
+[![CRAN status](https://www.r-pkg.org/badges/version/lpjmlstats)](https://cran.r-project.org/package=lpjmlstats)  [![R build status](https://github.com/PIK-LPJmL/lpjmlstats/workflows/check/badge.svg)](https://github.com/PIK-LPJmL/lpjmlstats/actions) [![codecov](https://codecov.io/gh/PIK-LPJmL/lpjmlstats/branch/master/graph/badge.svg)](https://app.codecov.io/gh/PIK-LPJmL/lpjmlstats) [![r-universe](https://pik-piam.r-universe.dev/badges/lpjmlstats)](https://pik-piam.r-universe.dev/builds)
 
 ## Purpose and Functionality
 
@@ -48,7 +48,7 @@ In case of questions / problems please contact David Hötten <davidho@pik-potsda
 
 To cite package **lpjmlstats** in publications use:
 
-Hötten D, Breier J (2024). _lpjmlstats: Statistical tools for LPJmL data analysis_. R package version 0.2.2.
+Hötten D, Breier J (2024). _lpjmlstats: Statistical tools for LPJmL data analysis_. R package version 0.2.3, <URL: https://github.com/PIK-LPJmL/lpjmlstats>.
 
 A BibTeX entry for LaTeX users is
 
@@ -57,6 +57,7 @@ A BibTeX entry for LaTeX users is
   title = {lpjmlstats: Statistical tools for LPJmL data analysis},
   author = {David Hötten and Jannes Breier},
   year = {2024},
-  note = {R package version 0.2.2},
+  note = {R package version 0.2.3},
+  url = {https://github.com/PIK-LPJmL/lpjmlstats},
 }
 ```