Skip to content

Latest commit

 

History

History
63 lines (41 loc) · 2.36 KB

README.md

File metadata and controls

63 lines (41 loc) · 2.36 KB

Statistical tools for LPJmL data analysis

R package lpjmlstats, version 0.6.0

CRAN status R build status codecov r-universe

Purpose and Functionality

This package provides statistical tools for LPJmL data analysis to be used for benchmarking LPJmL outputs.

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

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("benchmark-change-settings") # benchmark-change-settings
vignette("benchmark")                 # benchmark

Questions / Problems

In case of questions / problems please contact David Hötten [email protected].

Citation

To cite package lpjmlstats in publications use:

Hötten D, Breier J, Müller C (2024). lpjmlstats: Statistical tools for LPJmL data analysis. R package version 0.6.0, https://github.com/PIK-LPJmL/lpjmlstats.

A BibTeX entry for LaTeX users is

@Manual{,
 title = {lpjmlstats: Statistical tools for LPJmL data analysis},
 author = {David Hötten and Jannes Breier and Christoph Müller},
 year = {2024},
 note = {R package version 0.6.0},
 url = {https://github.com/PIK-LPJmL/lpjmlstats},
}