README.Rmd

---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# reportIMPACT

<!-- badges: start -->
[![R-CMD-check](https://github.com/IFPRI/reportIMPACT/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/IFPRI/reportIMPACT/actions/workflows/R-CMD-check.yaml)
[![license](https://img.shields.io/badge/Licence-GPL%20(%3E%3D%203)-red)](https://github.com/IFPRI/reportIMPACT/blob/master/LICENSE.md)


<!-- badges: end -->

The goal of `reportIMPACT` is to be able to generate some basic outputs from an IMPACT model run which are compiled in a `rds` (_R Data Serialization_) format which saves a compressed and aggregated version of basic indicators from an IMPACT run.

## Installation

Package `DOORMAT` is required for proper functioning of the `reportIMPACT` package. It can be installed with

``` r
# install.packages("devtools")
devtools::install_github("IFPRI/DOORMAT")
```

You can install the latest version of reportIMPACT from [GitHub](https://github.com/) with:

``` r
# install.packages("devtools")
devtools::install_github("IFPRI/reportIMPACT")
```

## Questions / Problems

In case of questions / problems please contact Abhijeet Mishra (A.Mishra@cgiar.org)