Merge pull request #425 from orichters/conv2005-17

tutorial update

.buildlibrary

@@ -1,4 +1,4 @@
-ValidationKey: '8111108'
+ValidationKey: '8113936'
 AutocreateReadme: yes
 allowLinterWarnings: no
 AddInReadme: tutorial.md

CITATION.cff

@@ -3,7 +3,7 @@ message: If you use this software, please cite it using the metadata from this f
 type: software
 title: 'piamInterfaces: Project specific interfaces to REMIND / MAgPIE'
 version: 0.40.4
-date-released: '2024-12-20'
+date-released: '2024-12-27'
 abstract: Project specific interfaces to REMIND / MAgPIE.
 authors:
 - family-names: Benke

DESCRIPTION

@@ -2,7 +2,7 @@ Type: Package
 Package: piamInterfaces
 Title: Project specific interfaces to REMIND / MAgPIE
 Version: 0.40.4
-Date: 2024-12-20
+Date: 2024-12-27
 Authors@R: c(
     person("Falk", "Benke", , "[email protected]", role = c("aut", "cre")),
     person("Oliver", "Richters", role = "aut")

README.md

@@ -23,7 +23,7 @@ serve to map variables from the PIAM framework to variables needed for the submi
 The mappings are `;`-separated files, using `#` as comment character, with the following mandatory columns:
 
 - `variable`: name of the variable in the project template
-- `unit`: unit corresponding to `variable`
+- `unit`: unit corresponding to `variable`. If the IIASA template has no unit, use `unitless`.
 - `piam_variable`: name of the variable in REMIND / MAgPIE / EDGE-T etc. reporting
 - `piam_unit`: unit corresponding to `piam_variable`
 - `piam_factor`: factor with which the `piam_variable` has to be multiplied for units to match
@@ -62,6 +62,11 @@ You can edit the files in LibreOffice Calc using these settings in the Text Impo
   - String Delimiter: (none)
 
 The github diff on a large semicolon-separated file is often unreadable.
+For a human-readable output, save the old version of the mapping and run:
+```
+remind2::compareScenConf(fileList = c("oldfile.csv", "mappingfile.csv"), row.names = NULL, expanddata = FALSE)
+```
+On the PIK cluster, you can run `comparescenconf mapping_AR6.csv` in the `inst/mappings` folder and it will compare to a recent `master` version.
 
 ### Creating a new mapping
 
@@ -118,15 +123,17 @@ In case of questions / problems please contact Falk Benke <[email protected]>
 
 To cite package **piamInterfaces** in publications use:
 
-Benke F, Richters O (2024). "piamInterfaces: Project specific interfaces to REMIND / MAgPIE - Version 0.40.4."
+Benke F, Richters O (2024). "piamInterfaces: Project specific interfaces to REMIND / MAgPIE." Version: 0.40.4, <https://github.com/pik-piam/piamInterfaces>.
 
 A BibTeX entry for LaTeX users is
 
  ```latex
 @Misc{,
-  title = {piamInterfaces: Project specific interfaces to REMIND / MAgPIE - Version 0.40.4},
+  title = {piamInterfaces: Project specific interfaces to REMIND / MAgPIE},
   author = {Falk Benke and Oliver Richters},
-  date = {2024-12-20},
+  date = {2024-12-27},
   year = {2024},
+  url = {https://github.com/pik-piam/piamInterfaces},
+  note = {Version: 0.40.4},
 }
 ```

tutorial.md

@@ -14,7 +14,7 @@ serve to map variables from the PIAM framework to variables needed for the submi
 The mappings are `;`-separated files, using `#` as comment character, with the following mandatory columns:
 
 - `variable`: name of the variable in the project template
-- `unit`: unit corresponding to `variable`
+- `unit`: unit corresponding to `variable`. If the IIASA template has no unit, use `unitless`.
 - `piam_variable`: name of the variable in REMIND / MAgPIE / EDGE-T etc. reporting
 - `piam_unit`: unit corresponding to `piam_variable`
 - `piam_factor`: factor with which the `piam_variable` has to be multiplied for units to match
@@ -53,6 +53,11 @@ You can edit the files in LibreOffice Calc using these settings in the Text Impo
   - String Delimiter: (none)
 
 The github diff on a large semicolon-separated file is often unreadable.
+For a human-readable output, save the old version of the mapping and run:
+```
+remind2::compareScenConf(fileList = c("oldfile.csv", "mappingfile.csv"), row.names = NULL, expanddata = FALSE)
+```
+On the PIK cluster, you can run `comparescenconf mapping_AR6.csv` in the `inst/mappings` folder and it will compare to a recent `master` version.
 
 ### Creating a new mapping