diff --git a/.buildlibrary b/.buildlibrary index 429fbd24..e319e051 100644 --- a/.buildlibrary +++ b/.buildlibrary @@ -1,4 +1,4 @@ -ValidationKey: '231860058' +ValidationKey: '232170880' AcceptedWarnings: - .*following variables are expected in the piamInterfaces.* - Summation checks have revealed some gaps.* diff --git a/CITATION.cff b/CITATION.cff index f7327740..0e488d5a 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: 'remind2: The REMIND R package (2nd generation)' -version: 1.158.2 -date-released: '2024-10-23' +version: 1.159.0 +date-released: '2024-11-05' abstract: Contains the REMIND-specific routines for data and model output manipulation. authors: - family-names: Rodrigues diff --git a/DESCRIPTION b/DESCRIPTION index 4b8b3c05..4568ae9f 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,8 +1,8 @@ Type: Package Package: remind2 Title: The REMIND R package (2nd generation) -Version: 1.158.2 -Date: 2024-10-23 +Version: 1.159.0 +Date: 2024-11-05 Authors@R: c( person("Renato", "Rodrigues", , "renato.rodrigues@pik-potsdam.de", role = c("aut", "cre")), person("Lavinia", "Baumstark", role = "aut"), diff --git a/R/modifyInvestmentVariables.R b/R/modifyInvestmentVariables.R index 0e94e05b..f1c088b5 100644 --- a/R/modifyInvestmentVariables.R +++ b/R/modifyInvestmentVariables.R @@ -10,7 +10,6 @@ #' #' See also: https://github.com/remindmodel/remind/pull/1238. #' -#' @seealso \code{\link{quitte::remind_timesteps}} #' #' @param x a magclass object to be manipulated, must have timesteps in 'ttot' #' @param ref an optional magclass object to be used for fixing values before 'startYear' diff --git a/README.md b/README.md index 624ae878..324dd9bf 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # The REMIND R package (2nd generation) -R package **remind2**, version **1.158.2** +R package **remind2**, version **1.159.0** [![CRAN status](https://www.r-pkg.org/badges/version/remind2)](https://cran.r-project.org/package=remind2) [![R build status](https://github.com/pik-piam/remind2/workflows/check/badge.svg)](https://github.com/pik-piam/remind2/actions) [![codecov](https://codecov.io/gh/pik-piam/remind2/branch/master/graph/badge.svg)](https://app.codecov.io/gh/pik-piam/remind2) [![r-universe](https://pik-piam.r-universe.dev/badges/remind2)](https://pik-piam.r-universe.dev/builds) @@ -49,7 +49,7 @@ In case of questions / problems please contact Renato Rodrigues . +Rodrigues R, Baumstark L, Benke F, Dietrich J, Dirnaichner A, Duerrwaechter J, Führlich P, Giannousakis A, Hasse R, Hilaire J, Klein D, Koch J, Kowalczyk K, Levesque A, Malik A, Merfort A, Merfort L, Morena-Leiva S, Pehl M, Pietzcker R, Rauner S, Richters O, Rottoli M, Schötz C, Schreyer F, Siala K, Sörgel B, Spahr M, Strefler J, Verpoort P, Weigmann P, Rüter T (2024). _remind2: The REMIND R package (2nd generation)_. R package version 1.159.0, . A BibTeX entry for LaTeX users is @@ -58,7 +58,7 @@ A BibTeX entry for LaTeX users is title = {remind2: The REMIND R package (2nd generation)}, author = {Renato Rodrigues and Lavinia Baumstark and Falk Benke and Jan Philipp Dietrich and Alois Dirnaichner and Jakob Duerrwaechter and Pascal Führlich and Anastasis Giannousakis and Robin Hasse and Jérome Hilaire and David Klein and Johannes Koch and Katarzyna Kowalczyk and Antoine Levesque and Aman Malik and Anne Merfort and Leon Merfort and Simón Morena-Leiva and Michaja Pehl and Robert Pietzcker and Sebastian Rauner and Oliver Richters and Marianna Rottoli and Christof Schötz and Felix Schreyer and Kais Siala and Björn Sörgel and Mike Spahr and Jessica Strefler and Philipp Verpoort and Pascal Weigmann and Tonn Rüter}, year = {2024}, - note = {R package version 1.158.2}, + note = {R package version 1.159.0}, url = {https://github.com/pik-piam/remind2}, } ``` diff --git a/man/convGDX2MIF_LCOE.Rd b/man/convGDX2MIF_LCOE.Rd index 83c3216c..b2209f83 100644 --- a/man/convGDX2MIF_LCOE.Rd +++ b/man/convGDX2MIF_LCOE.Rd @@ -6,7 +6,7 @@ \usage{ convGDX2MIF_LCOE( gdx, - gdx_ref, + gdx_ref = NULL, file = NULL, scenario = "default", t = c(seq(2005, 2060, 5), seq(2070, 2110, 10), 2130, 2150) diff --git a/man/modifyInvestmentVariables.Rd b/man/modifyInvestmentVariables.Rd index d504ca31..c72a8a38 100644 --- a/man/modifyInvestmentVariables.Rd +++ b/man/modifyInvestmentVariables.Rd @@ -7,20 +7,23 @@ modifyInvestmentVariables(x, ref = NULL, startYear = NULL) } \arguments{ -\item{x}{a magclass object to be manipulated} +\item{x}{a magclass object to be manipulated, must have timesteps in 'ttot'} \item{ref}{an optional magclass object to be used for fixing values before 'startYear'} \item{startYear}{years before will be overwritten with values from 'ref'} } \description{ -a helper to adapt investment variables in reporting after changes in -https://github.com/remindmodel/remind/pull/1238 +This function transforms investment variables to the normal reporting convention. } \details{ -for a given magclass object, calculates the value of each timestep -as the average of this timestep and the next timestep -the data for the last timestep in the magclass object remains unchanged +Years represented by investment variables in the energy system +('vm_deltaCap', 'vm_costInvTeDir' and 'vm_costInvTeAdj') are different from the normal +reporting convention. In the current REMIND version, vm_deltacap(t) represents +the average of the years t-4..t, while in the general reporting +convention it represents the average of t-2.5..t+2.5 (for 5 year time steps). + +See also: https://github.com/remindmodel/remind/pull/1238. } \author{ Falk Benke diff --git a/man/reportCapacity.Rd b/man/reportCapacity.Rd index cabf6d6a..4ff4ca80 100644 --- a/man/reportCapacity.Rd +++ b/man/reportCapacity.Rd @@ -22,7 +22,8 @@ be created.} t=c(seq(2005,2060,5),seq(2070,2110,10),2130,2150)} \item{gdx_ref}{a GDX object as created by readGDX, or the path to a gdx of the reference run. -It is used to guarantee consistency for Moving Avg prices before cm_startyear} +It is used to guarantee consistency before 'cm_startyear' for capacity variables +using time averaging.} } \value{ MAgPIE object - contains the capacity variables diff --git a/man/reportCapitalStock.Rd b/man/reportCapitalStock.Rd index 07e791af..dedaa1ce 100644 --- a/man/reportCapitalStock.Rd +++ b/man/reportCapitalStock.Rd @@ -22,7 +22,8 @@ be created.} t=c(seq(2005,2060,5),seq(2070,2110,10),2130,2150)} \item{gdx_ref}{a GDX object as created by readGDX, or the path to a gdx of the reference run. -It is used to guarantee consistency for Moving Avg prices before cm_startyear} +It is used to guarantee consistency before 'cm_startyear' for capacity variables +using time averaging.} } \value{ MAgPIE object - contains the capital stock variables diff --git a/man/reportEnergyInvestment.Rd b/man/reportEnergyInvestment.Rd index eec42f2a..638966d9 100644 --- a/man/reportEnergyInvestment.Rd +++ b/man/reportEnergyInvestment.Rd @@ -22,7 +22,8 @@ be created.} t=c(seq(2005,2060,5),seq(2070,2110,10),2130,2150)} \item{gdx_ref}{a GDX object as created by readGDX, or the path to a gdx of the reference run. -It is used to guarantee consistency for Moving Avg prices before cm_startyear} +It is used to guarantee consistency before 'cm_startyear' for investment variables +using time averaging.} } \value{ MAgPIE object - contains the price variables diff --git a/man/reportLCOE.Rd b/man/reportLCOE.Rd index 620a95ac..f4c225a4 100644 --- a/man/reportLCOE.Rd +++ b/man/reportLCOE.Rd @@ -15,7 +15,8 @@ Can be either "average" (returns only average LCOE), and "marginal detail" (returns table to trace back how marginal LCOE are calculated).} \item{gdx_ref}{a GDX object as created by readGDX, or the path to a gdx of the reference run. -It is used to guarantee consistency for Moving Avg prices before cm_startyear} +It is used to guarantee consistency before 'cm_startyear' for capacity and investment variables +using time averaging.} } \value{ MAgPIE object - LCOE calculated by model post-processing.