mikapfl / rOpenscmRunner

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Run different simple climate models from R using a unified interface

R package rOpenscmRunner, version 0.3.3

CRAN status R build status codecov r-universe

Purpose and Functionality

Using openscm-runner, you can run different simple climate models using a unified API. It supports emissions-driven runs only. rOpenscmRunner is a wrapper to easily use openscm-runner from R.

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

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("rOpenscmRunner") # rOpenscmRunner

Questions / Problems

In case of questions / problems please contact Mika Pflüger mika.pflueger@pik-potsdam.de.

Citation

To cite package rOpenscmRunner in publications use:

Pflüger M (2023). rOpenscmRunner: Run different simple climate models from R using a unified interface. R package version 0.3.3, https://github.com/pik-piam/rOpenscmRunner.

A BibTeX entry for LaTeX users is

@Manual{,
 title = {rOpenscmRunner: Run different simple climate models from R using a unified interface},
 author = {Mika Pflüger},
 year = {2023},
 note = {R package version 0.3.3},
 url = {https://github.com/pik-piam/rOpenscmRunner},
}

About

License:Other


Languages

Language:R 82.4%Language:Makefile 12.5%Language:Python 5.2%