Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/IAMconsortium/iamc

R package to work with IAMC-format data
https://github.com/IAMconsortium/iamc

Last synced: 4 months ago
JSON representation

R package to work with IAMC-format data

Awesome Lists containing this project

README

        

# IAMC Tools

R package **iamc**, version **0.29.8**

[![CRAN status](https://www.r-pkg.org/badges/version/iamc)](https://cran.r-project.org/package=iamc) [![R build status](https://github.com/giannou/iamc/workflows/check/badge.svg)](https://github.com/giannou/iamc/actions) [![codecov](https://codecov.io/gh/giannou/iamc/branch/master/graph/badge.svg)](https://app.codecov.io/gh/giannou/iamc) [![r-universe](https://pik-piam.r-universe.dev/badges/iamc)](https://pik-piam.r-universe.dev/builds)

## Purpose and Functionality

A collection of R tools provided by the Integrated Assessment Modeling Consortium (IAMC) for data analysis and diagnostics.

## Installation

For installation of the most recent package version an additional repository has to be added in R:

```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`:

```r
install.packages("iamc")
```

Package updates can be installed using `update.packages` (make sure that the additional repository has been added before running that command):

```r
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):

```r
vignette("iamc") # Using and adding IAMC data checks
```

## Questions / Problems

In case of questions / problems please contact Jan Philipp Dietrich .

## Citation

To cite package **iamc** in publications use:

Dietrich J, Auer C, Giannousakis A, Bertram C, Benke F, Humpenoeder F, Baumstark L (2023). _iamc: IAMC Tools_. R package version 0.29.8.

A BibTeX entry for LaTeX users is

```latex
@Manual{,
title = {iamc: IAMC Tools},
author = {Jan Philipp Dietrich and Cornelia Auer and Anastasis Giannousakis and Christoph Bertram and Falk Benke and Florian Humpenoeder and Lavinia Baumstark},
year = {2023},
note = {R package version 0.29.8},
}
```