Skip to content

pik-piam/remulator

Repository files navigation

R emulator

R package remulator, version 1.22.0

CRAN status DOI R build status codecov r-universe

Purpose and Functionality

A collection of R tools for fitting model results.

Installation

For installation of the most recent package version an additional repository has to be added in R:

options(repos = c(CRAN = "@CRAN@", pik = "https://rse.pik-potsdam.de/r/packages"))

The additional repository can be made available permanently by adding the line above to a file called .Rprofile stored in the home folder of your system (Sys.glob("~") in R returns the home directory).

After that the most recent version of the package can be installed using install.packages:

install.packages("remulator")

Package updates can be installed using update.packages (make sure that the additional repository has been added before running that command):

update.packages()

Tutorial

The package comes with vignettes describing the basic functionality of the package and how to use it. You can load them with the following command (the package needs to be installed):

vignette("magpie_emulator_for_remind") # How to produce bioenergy supply price curves for REMIND 3.0 using MAgPIE 5.0 (MAgPIE Emulator)
vignette("remulator")                  # Fitting curves to data (in magclass format) and plotting the curves to nice graphs and pdf

Questions / Problems

In case of questions / problems please contact David Klein dklein@pik-potsdam.de.

Citation

To cite package remulator in publications use:

Klein D (2023). remulator: R emulator. doi: 10.5281/zenodo.2546517 (URL: https://doi.org/10.5281/zenodo.2546517), R package version 1.22.0, <URL: https://github.com/pik-piam/remulator>.

A BibTeX entry for LaTeX users is

@Manual{,
 title = {remulator: R emulator},
 author = {David Klein},
 year = {2023},
 note = {R package version 1.22.0},
 doi = {10.5281/zenodo.2546517},
 url = {https://github.com/pik-piam/remulator},
}