Skip to content

Latest commit

 

History

History
61 lines (39 loc) · 2.33 KB

README.md

File metadata and controls

61 lines (39 loc) · 2.33 KB
Raw

Create comparison plots for your model results

R package piamPlotComparison, version 0.0.16

CRAN status R build status codecov r-universe

Purpose and Functionality

A frameworks to create comparison plots for your 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("piamPlotComparison")

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 a vignette describing the basic functionality of the package and how to use it. You can load it with the following command (the package needs to be installed):

vignette("compareScenarios") # compareScenarios

Questions / Problems

In case of questions / problems please contact Falk Benke [email protected].

Citation

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.16, https://github.com/pik-piam/piamPlotComparison.

A BibTeX entry for LaTeX users is

@Manual{,
 title = {piamPlotComparison: Create comparison plots for your model results},
 author = {Falk Benke and Christof Schoetz},
 year = {2024},
 note = {R package version 0.0.16},
 url = {https://github.com/pik-piam/piamPlotComparison},
}