Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/JaseZiv/worldfootballR
A wrapper for extracting world football (soccer) data from FBref, Transfermark, Understat
https://github.com/JaseZiv/worldfootballR
cran fbref football football-data r r-package rstats soccer-data sports-data transfermarkt understat
Last synced: 5 days ago
JSON representation
A wrapper for extracting world football (soccer) data from FBref, Transfermark, Understat
- Host: GitHub
- URL: https://github.com/JaseZiv/worldfootballR
- Owner: JaseZiv
- Created: 2021-01-01T10:00:12.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-06-29T10:27:11.000Z (12 days ago)
- Last Synced: 2024-06-29T11:31:38.971Z (12 days ago)
- Topics: cran, fbref, football, football-data, r, r-package, rstats, soccer-data, sports-data, transfermarkt, understat
- Language: R
- Homepage: https://jaseziv.github.io/worldfootballR/
- Size: 18.1 MB
- Stars: 430
- Watchers: 14
- Forks: 58
- Open Issues: 17
-
Metadata Files:
- Readme: README.Rmd
- Changelog: NEWS.md
- Contributing: .github/CONTRIBUTING.md
Lists
- awesome-football - **JaseZiv/worldfootballR**
- football_analytics - `worldfootballR` - data-using-worldfootballr/)]) (Uncategorized / Uncategorized)
README
---
output: github_document
---```{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
[![Version-Number](https://img.shields.io/github/r-package/v/JaseZiv/worldfootballR?label=worldfootballR (Dev))](https://github.com/JaseZiv/worldfootballR/)
[![R build status](https://github.com/JaseZiv/worldfootballR/workflows/R-CMD-check/badge.svg)](https://github.com/JaseZiv/worldfootballR/actions)
[![codecov](https://codecov.io/gh/JaseZiv/worldfootballR/branch/main/graph/badge.svg?token=WGLU5J34VL)](https://app.codecov.io/gh/JaseZiv/worldfootballR)[![CRAN status](https://www.r-pkg.org/badges/version-last-release/worldfootballR?style=for-the-badge)](https://CRAN.R-project.org/package=worldfootballR)
[![CRAN downloads](http://cranlogs.r-pkg.org/badges/grand-total/worldfootballR)](https://CRAN.R-project.org/package=worldfootballR)
[![Downloads](https://cranlogs.r-pkg.org/badges/worldfootballR)](https://cran.r-project.org/package=worldfootballR)## Overview
This package is designed to allow users to extract various world football results and player statistics from the following popular football (soccer) data sites:
* FBref
* [Transfermarkt](https://www.transfermarkt.com/)
* [Understat](https://understat.com/)## Installation
As at 2024-06-29, we are no longer including instructions to install from CRAN. The version pushed to CRAN is very much out of date, and with very regular updates to this library, we advise installing from GitHub only.
You can install the released version of [**```worldfootballR```**](https://github.com/JaseZiv/worldfootballR/) from [GitHub](https://github.com/JaseZiv/worldfootballR) 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 functions to extract data from FBref, see [here](https://jaseziv.github.io/worldfootballR/articles/extract-fbref-data.html)
* For functions to extract data from Transfermarkt, see [here](https://jaseziv.github.io/worldfootballR/articles/extract-transfermarkt-data.html)
* For functions to extract data from Understat, see [here](https://jaseziv.github.io/worldfootballR/articles/extract-understat-data.html)
* For functions to extract data for international matches from FBref, see [here](https://jaseziv.github.io/worldfootballR/articles/fbref-data-internationals.html)
* For functions to load pre-scraped data, see [here](https://jaseziv.github.io/worldfootballR/articles/load-scraped-data.html)### Loading Data
Since the release of `v0.5.3`, the library now supports very rapid loading of pre-collected data through the use of `load_` functions.
The data available for loading is stored in the `worldfootballR_data` repository. The repo can be found [here](https://github.com/JaseZiv/worldfootballR_data).
Head to the vignette [here](https://jaseziv.github.io/worldfootballR/articles/load-scraped-data.html) to see examples of which data is available for rapid loading.
***
## News
To stay up-to-date with the latest changes, see the package [change log](https://jaseziv.github.io/worldfootballR/news/index.html)
Note that fotmob data is no longer provided since the release of `v0.6.4` due to a change in their [terms of service](https://www.fotmob.com/tos.txt).
***
## Leagues and Seasons
### FBref
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/all_leages_and_cups/all_competitions.csv)
### Transfermarkt
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)
### Understat
The following leagues are currently supported by Understat (these values can be passed in to the `league` arguments of most `understat_` functions):
* "EPL"
* "La liga"
* "Bundesliga"
* "Serie A"
* "Ligue 1"
* "RFPL"***
## Attribute the Source
When using the functions in the package, **please ensure you attribute the source of the data based on the function you use**.
Data providers are listed below:
* [FBref](https://fbref.com/en/) partnered with StatsPerform Opta
* [Transfermarkt](https://www.transfermarkt.com/)
* [Understat](https://understat.com/)### Acknowledgements
Special mention goes out to [Ewan Henderson's](https://github.com/ewenme) awesome [`understatr`](https://github.com/ewenme/understatr) library for the inspiration and internal code for the `understat_` functions contained in this package.
***
## Contributing
### Issues and Improvements
Before creating an issue, **please ensure you have the latest version installed from GitHub**. Check the changelog for more details on changes that have been made to the library.
When creating an issue, please include:
* Reproducible examples
* A brief description of what the expected results are
* If applicable, the fbref.com, transfermarkt.com or understat.com page the observed behaviour is occurring on
* For improvement suggestions, what features are being requested and their purposeFeel free to get in touch via email or twitter https://twitter.com/jaseziv if you aren't able to create an issue.
### Show your support
Follow me on Twitter ([jaseziv](https://twitter.com/jaseziv)) for updatesIf this package helps you, all I ask is that you star this repo. If you did want to show your support and contribute to server time and data storage costs, feel free to send a small donation through the link below.