Skip to content

Latest commit

 

History

History
64 lines (45 loc) · 1.93 KB

README.md

File metadata and controls

64 lines (45 loc) · 1.93 KB

Travis build status Codecov test coverage Lifecycle: experimental CRAN status

yelpr

R client for accessing the Yelp Fusion API.

Installation

You can install the in-development version from GitHub using the remotes package.

install.packages("devtools")
remotes::install_github("SamanthaToet/yelpr")

If you encounter a bug, have usage questions, or want to share ideas to make this package better, feel free to file an issue.

Connecting to Yelp

To interface with the Yelp API, you’ll need to register a Yelp Developer account and then create an app. Your app will auto generate a Client ID and API Key. Copy the value for the API Key and save that value in your keyring by running the below code:

keyring::key_set("yelp")

You will be promped to paste your API Key in a separate password window.

Example

Get a list of all the restaurants that have chicken wings in Charlottesville, VA:

yelp_search("chicken wings", "Charlottesville, VA")

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

License

MIT © Samantha Toet