-
Notifications
You must be signed in to change notification settings - Fork 66
/
Copy pathREADME.Rmd
79 lines (50 loc) · 2.78 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
---
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(tibble.print_min = 5, tibble.print_max = 5)
```
# worldfootballR <img src="man/figures/logo.png" align="right" width="181" height="201"/>
<!-- badges: start -->
[](https://travis-ci.org/JaseZiv/worldfootballR)
[](https://codecov.io/gh/JaseZiv/worldfootballR)
<!-- badges: end -->
## Overview
This package is designed to allow users to extract various world football results and player statistics data from fbref.com and valuations and transfer data from transfermarkt.com.
## Installation
You can install the `worldfootballR` package from github with:
```{r gh-installation, eval=FALSE}
# install.packages("devtools")
devtools::install_github("JaseZiv/worldfootballR")
```
```{r load_libs, warning=FALSE, message=FALSE}
library(worldfootballR)
```
***
## Usage
Package vignettes have been built to help you get started with the package.
* For match-level data, see [here](https://jaseziv.github.io/worldfootballR/articles/extract-match-data.html)
* For season-level data, see [here](https://jaseziv.github.io/worldfootballR/articles/extract-season-data.html)
* for transfer histories and player market valuations, see [here](https://jaseziv.github.io/worldfootballR/articles/extract-valuation-data.html)
***
## Leagues and Seasons
For fbref.com data (match and season data), a list of leagues and seasons included in the package can be found in the `worldfootballR_data` repository and can be found [here](https://github.com/JaseZiv/worldfootballR_data/blob/master/raw-data/league_seasons/all_tier1_season_URLs.csv)
For transfermarkt.com data (valuations and transfers), a list of leagues and seasons included in the package can be found in the `worldfootballR_data` repository and can be found [here](https://github.com/JaseZiv/worldfootballR_data/blob/master/raw-data/transfermarkt_leagues/main_comp_seasons.csv)
***
## Contributing
### Issues and Improvements
When creating an issue, please include:
* Reproducible examples
* A brief description of what the expected results are
* If applicable, the fbref.com or transfermarkt.com page the observed behaviour is occuring on
* For improvements, what addiditional features are being requested and what problem they will help solve
### Pull Requests
Pull requests are also welcomed. Before doing so, please create an issue or email me with your idea.
Feel free to get in touch via email or twitter https://twitter.com/jaseziv