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%"
)
options(width = 90)
library(googler)
```

# googler <img src='man/figures/logo.png' align="right" height="200" />
<!-- badges: start -->
[![Travis build status](https://travis-ci.org/mkearney/googler.svg?branch=master)](https://travis-ci.org/mkearney/googler)
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)
[![AppVeyor build status](https://ci.appveyor.com/api/projects/status/github/mkearney/googler?branch=master&svg=true)](https://ci.appveyor.com/project/mkearney/googler)
<!-- badges: end -->

This is a wrapper around the ['googler' command line tool](https://github.com/jarun/googler).

## Requirements

Python 3 must be installed and locatable


## Installation

You can install the development version of {googler} from [Github](https://github.com/mkearney/googler) with:

``` r
remotes::install_github("mkearney/googler")
```

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

<!-- ``` r -->
<!-- install.packages("googler") -->
<!-- ``` -->

## Examples

Search google with various options to specify things like the desired result **`count`**, google **`news`**, within a range of **`time`**, from a given **`site`**, etc.

### Example #1: Basic google search

```{r}
## search google for 'rstats'
googler("rstats")
```

### Example #2: Advanced google search

```{r}
## search google for 100 'rstats' or "R language" hits in English in past year
googler("rstats OR \"R language\"", count = 100, time = "y1", lang = "en")
```

### Example #3: Search google news

```{r}
## search google news for rstats/R language articles in the past three weeks
googler("rstats OR \"R language\"", news = TRUE)
```