Merge pull request #460 from 0UmfHxcvx5J7JoaOhFSs5mncnisTJJ6q/fix/#459

add unused argument used by madrat back to fullVALIDATIONREMIND()

.buildlibrary

@@ -1,4 +1,4 @@
-ValidationKey: '34324368'
+ValidationKey: '34396362'
 AcceptedWarnings:
 - 'Warning: package ''.*'' was built under R version'
 - 'Warning: namespace ''.*'' is not available and has been replaced'

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: 'mrremind: MadRat REMIND Input Data Package'
-version: 0.174.2
-date-released: '2023-12-13'
+version: 0.174.3
+date-released: '2024-01-12'
 abstract: The mrremind packages contains data preprocessing for the REMIND model.
 authors:
 - family-names: Baumstark

DESCRIPTION

@@ -1,8 +1,8 @@
 Type: Package
 Package: mrremind
 Title: MadRat REMIND Input Data Package
-Version: 0.174.2
-Date: 2023-12-13
+Version: 0.174.3
+Date: 2024-01-12
 Authors@R: c(
     person("Lavinia", "Baumstark", , "[email protected]", role = c("aut", "cre")),
     person("Renato", "Rodrigues", role = "aut"),

R/fullVALIDATIONREMIND.R

@@ -1,19 +1,21 @@
-#' fullVALIDATIONREMIND
+#' Generate Validation Data for REMIND
 #'
 #' Function that generates the historical regional dataset against which the
 #' REMIND model results can be compared.
 #'
-#' @param years A vector of years that should be returned. If set to NULL all
-#' available years are returned.
+#' @md
+#' @param rev Unused parameter here for the pleasure of [`madrat`].
+#' @param years A vector of years that should be returned. If set to `NULL` all
+#'     available years are returned.
 #' @author David Klein, Falk Benke
-#' @seealso
-#' \code{\link{fullREMIND}},\code{\link{readSource}},\code{\link{getCalculations}},\code{\link{calcOutput}}
+#' @seealso [`fullREMIND()`], [`readSource()`], [`getCalculations()`],
+#'     [`calcOutput()`]
 #' @examples
 #' \dontrun{
 #' fullVALIDATIONREMIND()
 #' }
-#'
-fullVALIDATIONREMIND <- function(years = NULL) {
+
+fullVALIDATIONREMIND <- function(rev = 0, years = NULL) {
   # get region mappings for aggregation ----
   # Determines all regions data should be aggregated to by examining the columns
   # of the `regionmapping` and `extramappings` currently configured.

README.md

@@ -1,6 +1,6 @@
 # MadRat REMIND Input Data Package
 
-R package **mrremind**, version **0.174.2**
+R package **mrremind**, version **0.174.3**
 
 [![CRAN status](https://www.r-pkg.org/badges/version/mrremind)](https://cran.r-project.org/package=mrremind)  [![R build status](https://github.com/pik-piam/mrremind/workflows/check/badge.svg)](https://github.com/pik-piam/mrremind/actions) [![codecov](https://codecov.io/gh/pik-piam/mrremind/branch/master/graph/badge.svg)](https://app.codecov.io/gh/pik-piam/mrremind) [![r-universe](https://pik-piam.r-universe.dev/badges/mrremind)](https://pik-piam.r-universe.dev/builds)
 
@@ -39,16 +39,16 @@ In case of questions / problems please contact Lavinia Baumstark <lavinia@pik-po
 
 To cite package **mrremind** in publications use:
 
-Baumstark L, Rodrigues R, Levesque A, Oeser J, Bertram C, Mouratiadou I, Malik A, Schreyer F, Soergel B, Rottoli M, Mishra A, Dirnaichner A, Pehl M, Giannousakis A, Klein D, Strefler J, Feldhaus L, Brecha R, Rauner S, Dietrich J, Bi S, Benke F, Weigmann P, Richters O, Hasse R, Fuchs S, Mandaroux R (2023). _mrremind: MadRat REMIND Input Data Package_. R package version 0.174.2, <URL: https://github.com/pik-piam/mrremind>.
+Baumstark L, Rodrigues R, Levesque A, Oeser J, Bertram C, Mouratiadou I, Malik A, Schreyer F, Soergel B, Rottoli M, Mishra A, Dirnaichner A, Pehl M, Giannousakis A, Klein D, Strefler J, Feldhaus L, Brecha R, Rauner S, Dietrich J, Bi S, Benke F, Weigmann P, Richters O, Hasse R, Fuchs S, Mandaroux R (2024). _mrremind: MadRat REMIND Input Data Package_. R package version 0.174.3, <https://github.com/pik-piam/mrremind>.
 
 A BibTeX entry for LaTeX users is
 
  ```latex
 @Manual{,
   title = {mrremind: MadRat REMIND Input Data Package},
   author = {Lavinia Baumstark and Renato Rodrigues and Antoine Levesque and Julian Oeser and Christoph Bertram and Ioanna Mouratiadou and Aman Malik and Felix Schreyer and Bjoern Soergel and Marianna Rottoli and Abhijeet Mishra and Alois Dirnaichner and Michaja Pehl and Anastasis Giannousakis and David Klein and Jessica Strefler and Lukas Feldhaus and Regina Brecha and Sebastian Rauner and Jan Philipp Dietrich and Stephen Bi and Falk Benke and Pascal Weigmann and Oliver Richters and Robin Hasse and Sophie Fuchs and Rahel Mandaroux},
-  year = {2023},
-  note = {R package version 0.174.2},
+  year = {2024},
+  note = {R package version 0.174.3},
   url = {https://github.com/pik-piam/mrremind},
 }
 ```