Merge pull request #10 from johanneskoch94/main

Make scenario argument in mrdrivers functions explicit

.buildlibrary

@@ -1,4 +1,4 @@
-ValidationKey: '1464453'
+ValidationKey: '1489250'
 AutocreateReadme: yes
 AcceptedWarnings:
 - 'Warning: package ''.*'' was built under R version'
@@ -7,3 +7,4 @@ AcceptedNotes: .* includes the non-default packages.*
 allowLinterWarnings: no
 enforceVersionUpdate: no
 skipCoverage: no
+AutocreateCITATION: yes

.github/workflows/check.yaml

@@ -44,6 +44,13 @@ jobs:
           [ -f requirements.txt ] && python -m pip install --upgrade pip wheel || true
           [ -f requirements.txt ] && pip install -r requirements.txt || true
 
+      - name: Run pre-commit checks
+        shell: bash
+        run: |
+          python -m pip install pre-commit
+          python -m pip freeze --local
+          pre-commit run --show-diff-on-failure --color=always --all-files
+
       - name: Verify validation key
         shell: Rscript {0}
         run: lucode2:::validkey(stopIfInvalid = TRUE)

.pre-commit-config.yaml

@@ -25,4 +25,4 @@ repos:
     -   id: readme-rmd-rendered
     -   id: use-tidy-description
 ci:
-    autoupdate_schedule: quarterly
+    autoupdate_schedule: weekly

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: 'mrfactors: MADRaT based package on factor inputs'
-version: 0.7.3
-date-released: '2024-12-04'
+version: 0.7.4
+date-released: '2025-02-06'
 abstract: This package provides functions for MAgPIE input data on factor inputs to
   agricultural production (with a focus on capital and labor).
 authors:

DESCRIPTION

@@ -1,8 +1,8 @@
 Type: Package
 Package: mrfactors
 Title: MADRaT based package on factor inputs
-Version: 0.7.3
-Date: 2024-12-04
+Version: 0.7.4
+Date: 2025-02-06
 Authors@R:
     c(person("Debbora", "Leip", , "leip@pik-potsdam.de", role = c("aut", "cre")),
       person("Edna", "Molina Bacca", role = "aut"))

R/calcAgCapLabourShare.R

@@ -39,7 +39,11 @@ calcAgCapLabourShare <- function(fillWithRegression = TRUE, projection = FALSE)
     regCoeff <- calcOutput("RegFactorShare", aggregate = FALSE)
 
     # calculate GDPpc [USD2017PPP] for regression
-    gdp <- calcOutput("GDPpc", naming = "scenario", unit = "constant 2017 Int$PPP", aggregate = FALSE)
+    gdp <- calcOutput("GDPpc",
+                      scenario = "SSPs",
+                      naming = "scenario",
+                      unit = "constant 2017 Int$PPP",
+                      aggregate = FALSE)
     if (!isFALSE(projection)) {
       years <- setdiff(getItems(gdp, dim = 2), paste0("y", seq(2105, 2150, 5)))
       gdp <- gdp[, years, projection]

R/calcHourlyLaborCosts.R

@@ -98,11 +98,11 @@ calcHourlyLaborCosts <- function(datasource = "USDA_FAO", dataVersionILO = "Aug2
       # remove outliers
       hourlyCosts[hourlyCosts > 100] <- 0 # unreasonable high values
       gdpMERpc <- calcOutput("GDPpc",
-                             scenario = "SSPs",
+                             scenario = "SSP2",
                              unit = "constant 2017 US$MER",
                              average2020 = FALSE,
                              naming = "scenario",
-                             aggregate = FALSE)[getItems(hourlyCosts, dim = 1), getItems(hourlyCosts, dim = 2), "SSP2"]
+                             aggregate = FALSE)[getItems(hourlyCosts, dim = 1), getItems(hourlyCosts, dim = 2), ]
       hourlyCosts[hourlyCosts < 0.1 & gdpMERpc > 3000] <- 0  # unreasonable low values
 
     } else if (datasource == "USDA_FAO") { # from USDA/FAO labor costs for crop+livst, ag. empl. and weekly hours

R/calcRegFactorShare.R

@@ -37,7 +37,7 @@ calcRegFactorShare <- function(datasource = "USDA", caseStudies = "CountryCaseSt
                                   extrapolation_type = "constant", integrate_interpolated_years = TRUE)
 
     # dependent variable
-    gdp <- calcOutput("GDPpc", naming = "scenario", unit = "constant 2017 Int$PPP", aggregate = FALSE)[, , "SSP2"]
+    gdp <- calcOutput("GDPpc", scenario = "SSP2", unit = "constant 2017 Int$PPP", aggregate = FALSE)
     gdp <- setNames(gdp, "GDP_pc")
 
     # mapping to case studies
@@ -55,7 +55,7 @@ calcRegFactorShare <- function(datasource = "USDA", caseStudies = "CountryCaseSt
                               from = "ISO", to = caseStudies, dim = 1)
 
     # aggregate GDP per capita using population as weight
-    pop <- calcOutput("Population", naming = "scenario", aggregate = FALSE)[, , "SSP2"]
+    pop <- calcOutput("Population", scenario = "SSP2", naming = "scenario", aggregate = FALSE)
     weight2 <- pop[countries, getYears(capShare), ]
     weight2[weight == 1e-12] <- 1e-12
     gdp <- toolAggregate(gdp[countries, getYears(capShare), ], rel = mapping,

README.md

@@ -1,6 +1,6 @@
 # MADRaT based package on factor inputs
 
-R package **mrfactors**, version **0.7.3**
+R package **mrfactors**, version **0.7.4**
 
 [![CRAN status](https://www.r-pkg.org/badges/version/mrfactors)](https://cran.r-project.org/package=mrfactors) [![R build status](https://github.com/pik-piam/mrfactors/workflows/check/badge.svg)](https://github.com/pik-piam/mrfactors/actions) [![codecov](https://codecov.io/gh/pik-piam/mrfactors/branch/master/graph/badge.svg)](https://app.codecov.io/gh/pik-piam/mrfactors) [![r-universe](https://pik-piam.r-universe.dev/badges/mrfactors)](https://pik-piam.r-universe.dev/builds)
 
@@ -38,16 +38,17 @@ In case of questions / problems please contact Debbora Leip <leip@pik-potsdam.de
 
 To cite package **mrfactors** in publications use:
 
-Leip D, Molina Bacca E (2024). _mrfactors: MADRaT based package on factor inputs_. R package version 0.7.3, <URL: https://github.com/pik-piam/mrfactors>.
+Leip D, Molina Bacca E (2025). "mrfactors: MADRaT based package on factor inputs." Version: 0.7.4, <https://github.com/pik-piam/mrfactors>.
 
 A BibTeX entry for LaTeX users is
 
  ```latex
-@Manual{,
+@Misc{,
   title = {mrfactors: MADRaT based package on factor inputs},
   author = {Debbora Leip and Edna {Molina Bacca}},
-  year = {2024},
-  note = {R package version 0.7.3},
+  date = {2025-02-06},
+  year = {2025},
   url = {https://github.com/pik-piam/mrfactors},
+  note = {Version: 0.7.4},
 }
 ```