diff --git a/.buildlibrary b/.buildlibrary index e3db442b7..51d851396 100644 --- a/.buildlibrary +++ b/.buildlibrary @@ -1,4 +1,4 @@ -ValidationKey: '8511606' +ValidationKey: '8532152' AutocreateReadme: yes allowLinterWarnings: no AddInReadme: tutorial.md diff --git a/CITATION.cff b/CITATION.cff index 9051f4666..d6721615b 100644 --- a/CITATION.cff +++ b/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: 'piamInterfaces: Project specific interfaces to REMIND / MAgPIE' -version: 0.42.3 -date-released: '2025-02-03' +version: 0.42.4 +date-released: '2025-02-04' abstract: Project specific interfaces to REMIND / MAgPIE. authors: - family-names: Benke diff --git a/DESCRIPTION b/DESCRIPTION index 93e97491a..095f9865e 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,8 +1,8 @@ Type: Package Package: piamInterfaces Title: Project specific interfaces to REMIND / MAgPIE -Version: 0.42.3 -Date: 2025-02-03 +Version: 0.42.4 +Date: 2025-02-04 Authors@R: c( person("Falk", "Benke", , "benke@pik-potsdam.de", role = c("aut", "cre")), person("Oliver", "Richters", role = "aut") diff --git a/README.md b/README.md index 9e091082f..7bbcbb6b0 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Project specific interfaces to REMIND / MAgPIE -R package **piamInterfaces**, version **0.42.3** +R package **piamInterfaces**, version **0.42.4** [![CRAN status](https://www.r-pkg.org/badges/version/piamInterfaces)](https://cran.r-project.org/package=piamInterfaces) [![R build status](https://github.com/pik-piam/piamInterfaces/workflows/check/badge.svg)](https://github.com/pik-piam/piamInterfaces/actions) [![codecov](https://codecov.io/gh/pik-piam/piamInterfaces/branch/master/graph/badge.svg)](https://app.codecov.io/gh/pik-piam/piamInterfaces) [![r-universe](https://pik-piam.r-universe.dev/badges/piamInterfaces)](https://pik-piam.r-universe.dev/builds) @@ -10,6 +10,8 @@ Project specific interfaces to REMIND / MAgPIE. # Tutorial +To improve the tutorial, edit [`tutorial.md`](./tutorial.md). + - To understand how to submit to the IIASA database, read this [REMIND tutorial](https://github.com/remindmodel/remind/blob/develop/tutorials/13_Submit_to_IIASA_database.md). - In the following, we differentiate templates (list of variables and corresponding units used in a project) @@ -70,6 +72,8 @@ remind2::compareScenConf(fileList = c("oldfile.csv", "mappingfile.csv"), row.nam ``` On the PIK cluster, you can run `comparescenconf mapping_AR6.csv` in the `inst/mappings` folder and it will compare to a recent `master` version. +After you adjusted the mapping, run `make test` on Linux (incl. the cluster) or `Rscript -e 'devtools::test(show_report = TRUE)'` on Windows, and various tests will be performed. + ### Renaming a piam_variable If a variable used as `piam_variable` has to be renamed, please add it with its `old_name` to [`inst/renamed_piam_variables.csv`](./inst/renamed_piam_variables.csv). @@ -143,7 +147,7 @@ In case of questions / problems please contact Falk Benke To cite package **piamInterfaces** in publications use: -Benke F, Richters O (2025). "piamInterfaces: Project specific interfaces to REMIND / MAgPIE." Version: 0.42.3, . +Benke F, Richters O (2025). "piamInterfaces: Project specific interfaces to REMIND / MAgPIE." Version: 0.42.4, . A BibTeX entry for LaTeX users is @@ -151,9 +155,9 @@ A BibTeX entry for LaTeX users is @Misc{, title = {piamInterfaces: Project specific interfaces to REMIND / MAgPIE}, author = {Falk Benke and Oliver Richters}, - date = {2025-02-03}, + date = {2025-02-04}, year = {2025}, url = {https://github.com/pik-piam/piamInterfaces}, - note = {Version: 0.42.3}, + note = {Version: 0.42.4}, } ```