hgr/README.Rmd

---
output: rmarkdown::github_document
editor_options: 
  chunk_output_type: console
---

`hgr` : Tools to Work with the 'Postlight' 'Mercury' 'API'

Mercury takes any web article and returns only the relevant content — headline, author, body text, relevant images and more — free from any clutter. You need an API key which you can get from [here](https://mercury.postlight.com).

The following functions are implemented:

- `just_the_facts`:	Retrieve parsed content of a URL processed by the Postlight Mercury API
- `clean_text`:	Remove all HTML/XML tags from an HTML document/atomic character vector

### Installation

```{r eval=FALSE}
devtools::install_github("hrbrmstr/hgr")
```

```{r message=FALSE, warning=FALSE, error=FALSE, include=FALSE}
options(width=120)
```

### Usage

```{r message=FALSE, warning=FALSE, error=FALSE}
library(hgr)

# current verison
packageVersion("hgr")

story <- "https://www.nytimes.com/2017/04/18/world/asia/aircraft-carrier-north-korea-carl-vinson.html?hp&action=click&pgtype=Homepage&clickSource=story-heading&module=first-column-region&region=top-news&WT.nav=top-news&_r=0"

doc <- just_the_facts(story)

dplyr::glimpse(doc)

substr(doc$content, 1, 100)

plain <- clean_text(doc$content)

substr(plain, 1, 100)
```

### Test Results

```{r message=FALSE, warning=FALSE, error=FALSE}
library(hgr)
library(testthat)

date()

test_dir("tests/")
```