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 -->
[![Travis build status](https://travis-ci.org/news-r/papers.svg?branch=master)](https://travis-ci.org/news-r/papers)
<!-- badges: end -->

# papers

Access online newspapers information.

## Installation

You can install the released version of papers Github with:

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

## Usage

You can either use `get_regions` and `get_papers` to get the latest data or you can use the `papers` dataset which should include all newspapers worldwide (at least the major ones).

## Data

```{r data}
data("papers", package = "papers")
head(papers)
```

## Example

```{r example}
library(papers)

# get the list of regions available
regions <- get_regions()

# get papers from a specific region
(papers <- get_papers(regions, "Belgium"))
```