-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathREADME.Rmd
118 lines (84 loc) · 5.16 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
---
output: github_document
---
#
# **oddsapiR** <a href='https://oddsapiR.sportsdataverse.org/'><img src='https://raw.githubusercontent.com/sportsdataverse/oddsapiR/main/logo.png' align="right" width="20%" min-width="100px"/></a>
<!-- badges: start -->
[](https://github.com/sportsdataverse/oddsapiR)
[](https://github.com/sportsdataverse/oddsapiR/actions/workflows/R-CMD-check.yaml) [](https://github.com/sportsdataverse/oddsapiR) [](https://github.com/sportsdataverse/oddsapiR/graphs/contributors)
[](https://twitter.com/SportsDataverse)
<!-- badges: end -->
```{r setup, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
To access the API, get a free API key from https://the-odds-api.com
Installation & Usage
## **Installation**
<!-- You can install the CRAN version of [**```oddsapiR```** ](https://CRAN.R-project.org/package=oddsapiR) with: -->
<!-- ```{r readme_cran_install, eval=FALSE} -->
<!-- install.packages("oddsapiR") -->
<!-- ``` -->
You can install the released version of [**`oddsapiR`**](https://github.com/sportsdataverse/oddsapiR) from [GitHub](https://github.com/sportsdataverse/oddsapiR) with:
```r
# You can install using the pacman package using the following code:
if (!requireNamespace('pacman', quietly = TRUE)){
install.packages('pacman')
}
pacman::p_load_current_gh("sportsdataverse/oddsapiR")
```
```r
# if you would prefer devtools installation
if (!requireNamespace('devtools', quietly = TRUE)){
install.packages('devtools')
}
# Alternatively, using the devtools package:
devtools::install_github(repo = "sportsdataverse/oddsapiR")
```
```r
git clone https://github.com/sportsdataverse/oddsapi
cd oddsapi
Rscript -e "devtools::install()"
```
#### **Odds API Keys**
The [Odds API](https://the-odds-api.com) requires an API key, here's a quick run-down:
* Using the key: You can save the key for consistent usage by adding `ODDS_API_KEY=XXXX-YOUR-API-KEY-HERE-XXXXX` to your .Renviron file (easily accessed via [**`usethis::edit_r_environ()`**](https://usethis.r-lib.org/reference/edit.html)). Run [**`usethis::edit_r_environ()`**](https://usethis.r-lib.org/reference/edit.html), a new script will pop open named `.Renviron`, **THEN** paste the following in the new script that pops up (with**out** quotations)
```r
ODDS_API_KEY = XXXX-YOUR-API-KEY-HERE-XXXXX
```
Save the script and **restart your RStudio session**, by clicking `Session` (in between `Plots` and `Build`) and click `Restart R` (there also exists the shortcut `Ctrl + Shift + F10` to restart your session). If set correctly, from then on you should be able to use any of the functions without any other changes.
* For less consistent usage: At the beginning of every session or within an R environment, save your API key as the environment variable `ODDS_API_KEY` (with quotations) using a command like the following.
```{r setenv}
Sys.setenv(ODDS_API_KEY = "XXXX-YOUR-API-KEY-HERE-XXXXX")
```
## **Documentation**
For more information on the package and function reference, please see
the [**`oddsapiR`** documentation website](https://oddsapiR.sportsdataverse.org).
## **Breaking Changes**
[**Full News on
Releases**](https://oddsapiR.sportsdataverse.org/news/index.html)
## Follow the [SportsDataverse](https://twitter.com/SportsDataverse) on Twitter and star this repo
[](https://twitter.com/SportsDataverse)
[](https://github.com/sportsdataverse/oddsapiR/stargazers/)
## **Our Authors**
- [Saiem Gilani](https://twitter.com/saiemgilani)
<a href="https://twitter.com/saiemgilani" target="blank"><img src="https://img.shields.io/twitter/follow/saiemgilani?color=blue&label=%40saiemgilani&logo=twitter&style=for-the-badge" alt="@saiemgilani" /></a>
<a href="https://github.com/saiemgilani" target="blank"><img src="https://img.shields.io/github/followers/saiemgilani?color=eee&logo=Github&style=for-the-badge" alt="@saiemgilani" /></a>
## **Citations**
To cite the [**`oddsapiR`**](https://oddsapiR.sportsdataverse.org) R package
in publications, use:
BibTex Citation
```bibtex
@misc{gilani_2022_oddsapiR,
author = {Gilani, Saiem},
title = {oddsapiR: The SportsDataverse's R Package for The Odds API.},
url = {https://oddsapiR.sportsdataverse.org},
year = {2022}
}
```