# dkanr  <img src="man/figures/dkanr_hex.PNG" align="right" />  


[![Travis-CI Build Status](https://travis-ci.org/worldbank/dkanr.svg?branch=master)](https://travis-ci.org/worldbank/dkanr)
[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/worldbank/dkanr?branch=master&svg=true)](https://ci.appveyor.com/project/worldbank/dkanr)
[![Coverage status](https://codecov.io/gh/worldbank/dkanr/branch/master/graph/badge.svg)](https://codecov.io/github/worldbank/dkanr?branch=master)
[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/dkanr)](https://cran.r-project.org/package=dkanr)
![CRAN](http://cranlogs.r-pkg.org/badges/dkanr?color=brightgreen)

## Overview

[DKAN](https://getdkan.org/) is an open data platform that enables publication and consumption of open data.

The `dkanr` package is an R client to the [DKAN REST API](https://dkan.readthedocs.io/en/latest/apis/rest-api.html) that aims to facilitate the consumption, updating, and publication of content to open data platforms powered by DKAN. 

## Installation

You can install the released version of dkanr from [CRAN](https://CRAN.R-project.org) with:

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

And the development version from [GitHub](https://github.com/) with:

``` r
# install.packages("devtools")
devtools::install_github("worldbank/dkanr")
```
## Example

![](man/figures/dkanr_gif.gif)

To learn more about the features and functionalities of the package, view the Getting Started with dkanr [vignette](https://github.com/tonyfujs/dkanr/blob/master/vignettes/getting_started_with_dkanr.Rmd) for basic guidelines on how to use the package.

```r
browseVignettes(package = "dkanr")
```

