README.Rmd

---
output: 
  github_document:
    html_preview: false
---

<!-- 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%"
)
```

<!-- badges: start -->
[![Build status](https://ci.appveyor.com/api/projects/status/eoilou2fr917aew4?svg=true)](https://ci.appveyor.com/project/JohnCoene/fopi)
[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://www.tidyverse.org/lifecycle/#stable)
<!-- badges: end -->

# fopi

fopi contains with dataset, and a RESTful API for the Freedom of Press Index.


## API

From R

```r
fopi::run_api()
```

With docker

```bash
docker pull jcoenep/fopi
docker run --rm -p 3000:8000 jcoenep/fopi
```

Visit `http://127.0.0.1:3000/__swagger__/` for swagger docs.

## Data

You can access the data with.

``` r
data(fopi, package = "fopi")
```

Or via the [deployed API](http://app.news-r.org:2222/__swagger__/) but using the package.

```{r}
fopi::fopi_get_country("Switzerland")
```

## Get it

You can install the development version of fopi from Github with:

``` r
# install.packages("remotes")
remotes::install_github("news-r/fopi")
```