madrat based MAgPIE water Input Data Library

R package mrwater, version 1.13.7

Purpose and Functionality

Provides functions for MAgPIE cellular input data generation and stand-alone water calculations.

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("mrwater")

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("assumptions")        # mrwater Assumptions
vignette("available_settings") # Available argument settings in mrwater
vignette("mrwater")            # mrwater Documentation
vignette("riverstructure")     # mrwater River Structure

Questions / Problems

In case of questions / problems please contact Felicitas Beier beier@pik-potsdam.de.

Citation

To cite package mrwater in publications use:

Beier F, Heinke J, Karstens K, Bodirsky B, Dietrich J (2024). mrwater: madrat based MAgPIE water Input Data Library. R package version 1.13.7, https://github.com/pik-piam/mrwater.

A BibTeX entry for LaTeX users is

@Manual{,
 title = {mrwater: madrat based MAgPIE water Input Data Library},
 author = {Felicitas Beier and Jens Heinke and Kristine Karstens and Benjamin Leon Bodirsky and Jan Philipp Dietrich},
 year = {2024},
 note = {R package version 1.13.7},
 url = {https://github.com/pik-piam/mrwater},
}