adjust package metadata

DESCRIPTION

@@ -9,7 +9,7 @@ Authors@R: c(
   )
 Description: A frameworks to create comparison plots for your model results.
 License: LGPL-3
-URL: https://github.com/pik-piam/piamplotcomparison
+URL: https://github.com/pik-piam/piamPlotComparison
 Imports:
     dplyr,
     knitr,

README.md

@@ -2,7 +2,7 @@
 
 R package **piamPlotComparison**, version **0.0.4**
 
-[![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) 
+[![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)
 
 ## Purpose and Functionality
 

vignettes/compareScenarios.R

@@ -1,18 +1,18 @@
-## ----include = FALSE----------------------------------------------------------------------------------------------------------------
+## ----include = FALSE---------------------------------------------------------------------------------------------------------------
 knitr::opts_chunk$set(
   collapse = TRUE,
   comment = "#>",
   eval = FALSE
 )
 
-## -----------------------------------------------------------------------------------------------------------------------------------
+## ----------------------------------------------------------------------------------------------------------------------------------
 #  library(remind2)
 #  compareScenarios2(
 #    mifScen = c("path/to/Base.mif", "path/to/NDC.mif"),
 #    mifHist = "path/to/historical.mif",
 #    outputFile = "CompareScenarios2Example")
 
-## -----------------------------------------------------------------------------------------------------------------------------------
+## ----------------------------------------------------------------------------------------------------------------------------------
 #  library(remind2)
 #  compareScenarios2(
 #    mifScen = c("path/to/scen1.mif", "path/to/scen2.mif", "path/to/scen3.mif"), # TODO.
@@ -22,34 +22,34 @@ knitr::opts_chunk$set(
 #    # Add current time as output name to not overwrite other things:
 #    outputFile = format(Sys.time(), "CompScen2-%Y%m%d-%H%M%S"))
 
-## ----prepare mark-------------------------------------------------------------------------------------------------------------------
+## ----prepare mark------------------------------------------------------------------------------------------------------------------
 #  # CLICK "RUN ALL CHUNKS ABOVE" HERE TO PREPARE THE ENVIRONMENT
 
-## -----------------------------------------------------------------------------------------------------------------------------------
+## ----------------------------------------------------------------------------------------------------------------------------------
 #  library(remind2)
 #  loadModeltest()
 #  varList <- variablesAsList(data, entry = "INFO")
 #  View(varList) # in RStudio
 
-## -----------------------------------------------------------------------------------------------------------------------------------
+## ----------------------------------------------------------------------------------------------------------------------------------
 #  loadCs2Data(
 #    c("path/to/scen1.mif", "path/to/scen2.mif"), # TODO.
 #    "path/to/historical.mif") # TODO.
 
-## -----------------------------------------------------------------------------------------------------------------------------------
+## ----------------------------------------------------------------------------------------------------------------------------------
 #  compareScenarios2(
 #    mifScen = c("path/to/scen1.mif", "path/to/scen2.mif"), # TODO.
 #    mifHist = "path/to/historical.mif", # TODO.
 #    outputFile = format(Sys.time(), "cs2-%Y%m%d-%H%M%S"),
 #    sections = NN) # TODO: Replace NN by the number of the section you changed
 #  # (or by "all" to build the whole compare scenarios file, which will take a while).
 
-## -----------------------------------------------------------------------------------------------------------------------------------
+## ----------------------------------------------------------------------------------------------------------------------------------
 #  compareScenarios2(
 #    mifScen = c(newName1 = "path/to/scen1.mif", newName2 = "path/to/scen2.mif"),
 #    ...)
 
-## -----------------------------------------------------------------------------------------------------------------------------------
+## ----------------------------------------------------------------------------------------------------------------------------------
 #  compareScenarios2(
 #    mifScen = c("path/to/scen1.mif", "path/to/scen2.mif"),
 #    cfgScen = c("path/to/scen1/config.RData", "path/to/scen2/config.RData"),

vignettes/compareScenarios.Rmd

@@ -1,13 +1,13 @@
 ---
-title: "compareScenarios and REMIND"
+title: "compareScenarios"
 author: "Christof Schötz"
 date: "2024-04-05"
 output: 
   rmarkdown::html_vignette:
     toc: true
     number_sections: true
 vignette: >
-  %\VignetteIndexEntry{compareScenariosREMIND}
+  %\VignetteIndexEntry{compareScenarios}
   %\VignetteEngine{knitr::rmarkdown}
   %\VignetteEncoding{UTF-8}
 ---

vignettes/compareScenarios.html

@@ -10,7 +10,7 @@
 
 <meta name="viewport" content="width=device-width, initial-scale=1" />
 
-<meta name="author" content="Falk Benke" />
+<meta name="author" content="Christof Schötz" />
 
 <meta name="date" content="2024-04-05" />
 
@@ -339,7 +339,7 @@
 
 
 <h1 class="title toc-ignore">compareScenarios</h1>
-<h4 class="author">Falk Benke</h4>
+<h4 class="author">Christof Schötz</h4>
 <h4 class="date">2024-04-05</h4>
 
 
@@ -449,7 +449,7 @@ <h2><span class="header-section-number">2.1</span> output.R and
 Profiles</h2>
 <div id="output.r" class="section level3" number="2.1.1">
 <h3><span class="header-section-number">2.1.1</span> output.R</h3>
-<p>Typically we want to compare the results of some REMIND runs which
+<p>Typically, we want to compare the results of some REMIND runs which
 were created in the <code>remind/output/</code> folder of a clone of the
 REMIND repository. Assume such runs are available and, in particular,
 the
@@ -460,7 +460,7 @@ <h3><span class="header-section-number">2.1.1</span> output.R</h3>
 Select the runs of interest. We then can choose a filename prefix for
 the output file if we want. Next, choose a slurm mode, e.g.,
 <code>short</code> (the job will run for less than 1 hour, usually
-something like 20min). Finally we can choose a cs2-profile. Standard
+something like 20min). Finally, we can choose a cs2-profile. Standard
 profiles for the selected runs are colored. After choosing one or more
 profiles, the respective slurm jobs will be started. An HTML- or
 PDF-file will be created. If something goes wrong, take a look at the
@@ -469,15 +469,15 @@ <h3><span class="header-section-number">2.1.1</span> output.R</h3>
 <div id="profiles" class="section level3" number="2.1.2">
 <h3><span class="header-section-number">2.1.2</span> Profiles</h3>
 <p>A cs2-profile is a set of arguments for
-<code>compareScenarios2()</code>. There are different profiles for a
+<code>compareScenarios()</code>. There are different profiles for a
 comparison on the 12 main REMIND regions (<code>H12</code>,
 <code>H12-short</code>), or on the European regions (<code>EU27</code>,
 <code>EU27-short</code>) for 21-region-runs. The suffix
 <code>-short</code> indicates that only periods up to 2050 are
 considered. The <code>default</code>-profiles just call
-<code>compareScenarios2()</code> with the default arguments as described
-in <code>?remind2::compareScenarios2</code>. The available profiles are
-stored in <a href="https://github.com/remindmodel/remind/blob/develop/scripts/cs2/profiles.json"><code>remind/scripts/cs2/profiles.json</code></a>.
+<code>compareScenarios()</code> with the default arguments as described
+in <code>?piamPlotComparison::compareScenarios</code>. The available
+profiles are stored in <a href="https://github.com/remindmodel/remind/blob/develop/scripts/cs2/profiles.json"><code>remind/scripts/cs2/profiles.json</code></a>.
 Take a look at this file (open in text editor) to see the definition of
 each profile.</p>
 </div>
@@ -486,9 +486,9 @@ <h3><span class="header-section-number">2.1.3</span> Changing or Adding
 Profiles</h3>
 <p>To change a profile or add a new profile, just edit <a href="https://github.com/remindmodel/remind/blob/develop/scripts/cs2/profiles.json"><code>remind/scripts/cs2/profiles.json</code></a>.
 Read the <code>_DESCRIPTION_</code> in that file. Every argument
-(including YAML-arguments) to <code>compareScenarios2()</code> can be
-set or changed.</p>
-<p>We can create our own cs2-report: First we create an
+(including YAML-arguments) to <code>compareScenarios()</code> can be set
+or changed.</p>
+<p>We can create our own cs-report: First, we create an
 “section”-Rmd-file, similar to <code>cs2_NN_XXXX.Rmd</code> in <a href="https://github.com/pik-piam/remind2/tree/master/inst/markdown/compareScenarios2"><code>remind2/inst/markdown/compareScenarios2</code></a>.
 It typically contains calls to plot-function using an R-object called
 <code>data</code>. This objects stores all the information read from the