Merge pull request #8 from fbenke-pik/master

add getCs2Profiles

.buildlibrary

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

CITATION.cff

@@ -2,7 +2,7 @@ cff-version: 1.2.0
 message: If you use this software, please cite it using the metadata from this file.
 type: software
 title: 'piamPlotComparison: Create comparison plots for your model results'
-version: 0.0.9
+version: 0.0.10
 date-released: '2024-04-23'
 abstract: A frameworks to create comparison plots for your model results.
 authors:

DESCRIPTION

@@ -1,7 +1,7 @@
 Type: Package
 Package: piamPlotComparison
 Title: Create comparison plots for your model results
-Version: 0.0.9
+Version: 0.0.10
 Date: 2024-04-23
 Authors@R: c(
     person("Falk", "Benke", , "[email protected]", role = c("aut", "cre")),
@@ -12,6 +12,7 @@ License: LGPL-3
 URL: https://github.com/pik-piam/piamPlotComparison
 Imports:
     dplyr,
+    jsonlite,
     knitr,
     magclass,
     mip (>= 0.148.11),

NAMESPACE

@@ -2,6 +2,7 @@
 
 export(calcTimeSeriesStats)
 export(compareScenarios)
+export(getCs2Profiles)
 export(showStatsTable)
 importFrom(dplyr,"%>%")
 importFrom(dplyr,across)

R/getCs2Profiles.R

@@ -0,0 +1,24 @@
+#' Get the List of cs2 Profiles
+#'
+#' A list of arguments to \code{\link{compareScenarios}} is called a (cs2-)
+#' profile. This function loads a list of such profiles from a file. The default
+#' argument is set such that the default profiles file of REMIND is loaded.
+#'
+#' @param path \code{character(1)}. Path to the profiles file.
+#' @return A named list of profiles. The names are the names of the respective
+#'   profile. Each profile is a named list. Those names correspond to arguments
+#'   of \code{\link{compareScenarios}}.
+#' @author Christof Schoetz
+#' @examples
+#' \dontrun{
+#' profiles <- getCs2Profiles() # load from default location
+#' profiles <- getCs2Profiles(path = "path/to/profiles.json")
+#' }
+#' @export
+getCs2Profiles <- function(path = "./scripts/cs2/profiles.json") {
+  path <- normalizePath(path, mustWork = TRUE)
+  profiles <- jsonlite::read_json(path, simplifyVector = FALSE)
+  # Remove entries starting with "_". They are treated as comments.
+  profiles <- profiles[!startsWith(names(profiles), "_")]
+  return(profiles)
+}

README.md

@@ -1,6 +1,6 @@
 # Create comparison plots for your model results
 
-R package **piamPlotComparison**, version **0.0.9**
+R package **piamPlotComparison**, version **0.0.10**
 
 [![CRAN status](https://www.r-pkg.org/badges/version/piamPlotComparison)](https://cran.r-project.org/package=piamPlotComparison)  [![R build status](https://github.com/pik-piam/piamPlotComparison/workflows/check/badge.svg)](https://github.com/pik-piam/piamPlotComparison/actions) [![codecov](https://codecov.io/gh/pik-piam/piamPlotComparison/branch/master/graph/badge.svg)](https://app.codecov.io/gh/pik-piam/piamPlotComparison) [![r-universe](https://pik-piam.r-universe.dev/badges/piamPlotComparison)](https://pik-piam.r-universe.dev/builds)
 
@@ -46,7 +46,7 @@ In case of questions / problems please contact Falk Benke <[email protected]>
 
 To cite package **piamPlotComparison** in publications use:
 
-Benke F, Schoetz C (2024). _piamPlotComparison: Create comparison plots for your model results_. R package version 0.0.9, <https://github.com/pik-piam/piamPlotComparison>.
+Benke F, Schoetz C (2024). _piamPlotComparison: Create comparison plots for your model results_. R package version 0.0.10, <https://github.com/pik-piam/piamPlotComparison>.
 
 A BibTeX entry for LaTeX users is
 
@@ -55,7 +55,7 @@ A BibTeX entry for LaTeX users is
   title = {piamPlotComparison: Create comparison plots for your model results},
   author = {Falk Benke and Christof Schoetz},
   year = {2024},
-  note = {R package version 0.0.9},
+  note = {R package version 0.0.10},
   url = {https://github.com/pik-piam/piamPlotComparison},
 }
 ```

inst/compareScenarios/cs_main.Rmd

@@ -234,7 +234,7 @@ options(warn = 1)
 options(mip.mainReg = params$mainReg) # nolint
 options(mip.yearsBarPlot = params$yearsBarPlot) # nolint
 
-# Reference year for Kaya decomposition is params$yearRef or the first available year therafter.
+# Reference year for Kaya decomposition is params$yearRef or the first available year thereafter.
 options(kaya.refYear = min(params$yearsScen[params$yearsScen >= params$yearRef])) # nolint
 
 # allow for duplicate chunk labels