Skip to content

Commit cb37307

Browse files
committed
update readme
1 parent 091ee12 commit cb37307

File tree

2 files changed

+13
-33
lines changed

2 files changed

+13
-33
lines changed

README.Rmd

+7-12
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,13 @@ output:
1010
knitr::opts_chunk$set(echo = TRUE, warning = FALSE, message = FALSE, comment = "")
1111
```
1212

13-
```{r load extra packages}
14-
library(DT)
15-
```
16-
17-
18-
# yelpr
1913

2014
An R library for the [Yelp Fusion API](https://www.yelp.com/developers/documentation/v3/get_started)
2115

2216
## Installation
2317

18+
`devtools::install_github("OmaymaS/yelpr")`
19+
2420
## API Authentication
2521

2622
From [yelp authentication guide](https://www.yelp.com/developers/documentation/v3/authentication) :
@@ -71,13 +67,14 @@ business_ny <- business_search(api_key = key,
7167
limit = 5)
7268
```
7369

74-
The function returns a list, so we could see the details of the businesses as follows:
70+
The function returns a list, so we can extract the details of the businesses `business_ny$businesses`:
7571

76-
```{r print businesses details}
72+
```{r, echo = F}
7773
business_ny$businesses
7874
```
7975

8076

77+
8178
### Events Endpoint
8279

8380
The available functions are:
@@ -96,8 +93,6 @@ event <- event_search_featured(api_key = key,
9693
longitude = "-74.01385", latitude = "40.70387")
9794
```
9895

99-
And the event name would be:
100-
```{r prnt event name}
101-
event$name
102-
```
96+
And the event name `event$name` would be:
97+
**`r event$name`**
10398

README.md

+6-21
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,12 @@
33

44

55

6-
```r
7-
library(DT)
8-
```
9-
10-
11-
# yelpr
12-
136
An R library for the [Yelp Fusion API](https://www.yelp.com/developers/documentation/v3/get_started)
147

158
## Installation
169

10+
`devtools::install_github("OmaymaS/yelpr")`
11+
1712
## API Authentication
1813

1914
From [yelp authentication guide](https://www.yelp.com/developers/documentation/v3/authentication) :
@@ -67,13 +62,9 @@ business_ny <- business_search(api_key = key,
6762
limit = 5)
6863
```
6964

70-
The function returns a list, so we could see the details of the businesses as follows:
65+
The function returns a list, so we can extract the details of the businesses `business_ny$businesses`:
7166

7267

73-
```r
74-
business_ny$businesses
75-
```
76-
7768
```
7869
id alias
7970
1 k8GFfCXO2FIIJIo0ICYSRA bao-bao-cafe-new-york-3
@@ -150,6 +141,7 @@ business_ny$businesses
150141
```
151142

152143

144+
153145
### Events Endpoint
154146

155147
The available functions are:
@@ -169,13 +161,6 @@ event <- event_search_featured(api_key = key,
169161
longitude = "-74.01385", latitude = "40.70387")
170162
```
171163

172-
And the event name would be:
173-
174-
```r
175-
event$name
176-
```
177-
178-
```
179-
[1] "52 Things To Do in 2018"
180-
```
164+
And the event name `event$name` would be:
165+
**52 Things To Do in 2018**
181166

0 commit comments

Comments
 (0)