README.md

Run Analysis Tools

R package modelstats, version 0.22.0

Purpose and Functionality

A collection of tools to analyze model runs.

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

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("rs2")          # Run statistics 2 (rs2)
vignette("testingSuite") # Testing Suite

Questions / Problems

In case of questions / problems please contact Anastasis Giannousakis giannou@pik-potsdam.de.

Citation

To cite package modelstats in publications use:

Giannousakis A, Richters O (2024). modelstats: Run Analysis Tools. R package version 0.22.0, https://github.com/pik-piam/modelstats.

A BibTeX entry for LaTeX users is

@Manual{,
 title = {modelstats: Run Analysis Tools},
 author = {Anastasis Giannousakis and Oliver Richters},
 year = {2024},
 note = {R package version 0.22.0},
 url = {https://github.com/pik-piam/modelstats},
}