Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/abhiamishra/ggshakeR

An analysis and visualization R package that works with publicly available soccer data
https://github.com/abhiamishra/ggshakeR

analysis data-analysis data-visualization football-analytics library machine-learning plotting r soccer soccer-analytics visualization

Last synced: 28 days ago
JSON representation

An analysis and visualization R package that works with publicly available soccer data

Awesome Lists containing this project

README 

        
---

output: github_document

---



```{r, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "man/figures/README-",

  out.width = "100%",

  eval = FALSE

)

```



# ggshakeR 



[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

[![check-standard](https://github.com/abhiamishra/ggshakeR/workflows/R-CMD-check/badge.svg)](https://github.com/abhiamishra/ggshakeR/actions)

[![codecov](https://codecov.io/gh/abhiamishra/ggshakeR/branch/main/graph/badge.svg?token=GO5918U56P)](https://codecov.io/gh/abhiamishra/ggshakeR)



Welcome to `ggshakeR`!



This is R's all-inclusive package for visualization and analysis of publicly available soccer data.



This package aims to provide people interested in football analysis and visualization a platform to learn about it while also learning a new language at the same time. This package is designed to work with free soccer data and, for now, include:



* [FBref](https://fbref.com/en/)

* [StatsBomb Open Dataset](https://github.com/statsbomb/StatsBombR)

* [Understat](https://understat.com/)



Let's get you started with the package!



# Getting Started With ggshakeR



First things first, install R and RStudio. R is the actual language while RStudio is the IDE that will help you work with the R programming language in a nice way.



Here are links to download both:



* [R](https://www.r-project.org/)

* [RStudio](https://www.rstudio.com/products/rstudio/download/)



OK, now how do you get ggshakeR into RStudio? 



First install the devtools package:



```{r}

install.packages("devtools")

```



After that, write the actual code to install ggshakeR:



```{r}

devtools::install_github("abhiamishra/ggshakeR")

```



There were many __BIG__ changes made in __version 0.2.0__. Do note that the changes are permanent and will be the standard going forward. So please take the time to read the [Guide to Version 0.2.0 Vignette]() and the package documentation carefully so that you can transition over to the new argument syntax and make use of the new functionality that version `0.2.0` (and beyond!) will provide. If you want to go back to version `0.1.2` after you've already installed `0.2.0` (because you're not yet ready to edit your scripts to the new syntax or whatever), you can __re-install__ version `0.1.2` by running this:



```{r}

devtools::install_github("abhiamishra/[email protected]")

```



Now the package is installed, but it's not in your session just yet! When a package is in a session means you can actually use the package:



```{r}

library(ggshakeR)

```



And that's it you're done!



We hope you have fun!



## Helpful Links

Here are some helpful links to get you started with the package:



* [Guide To Pitch Plots](https://abhiamishra.github.io/ggshakeR/articles/Guide_to_Pitch_Plots.html)

* [Guide To Expected Threat](https://abhiamishra.github.io/ggshakeR/articles/Guide_to_Exp_Threat.html)

* [Guide To Pizza Plots](https://abhiamishra.github.io/ggshakeR/articles/Guide_to_PizzaPlots.html)

* [Guide To Expected Possession Value](https://abhiamishra.github.io/ggshakeR/articles/Guide_to_EPV.html)

* [Guide To Version 0.2.0](https://abhiamishra.github.io/ggshakeR/articles/Guide_to_Version_0-2-0.html)



# Credit

Thank you to StatsBomb and [Ewan Henderson](https://github.com/ewenme) for their respective packages. A big thank you to Ninad Barbadikar for creating the beautiful logo and helping with the package in general. Thank you [Jase Ziv](https://github.com/JaseZiv) for your help and your package [WorldFootballR](https://github.com/JaseZiv/worldfootballR) from which this took inspiration from. 



# Contact and Support

Tell your friends about ggshakeR and shake theiR lives away! 

You can contact me at [email]([email protected]) or at my [Twitter](https://twitter.com/MishraAbhiA)



Powered by Chatalytics:tm:



Owner and Creator: [__Abhishek Amol Mishra__](https://github.com/abhiamishra)



Authors: [__Harsh Krishna__](https://github.com/harshkrishna17) & [__Ryo Nakagawara__](https://github.com/Ryo-N7)



# Licenses Used

* [Torvaney](https://github.com/Torvaney/ggsoccer) and the ggsoccer package has been used in the package for creation of pitches. The use of this adheres to the [MIT License](https://github.com/Torvaney/ggsoccer/blob/master/LICENSE.md) provided. 



Licensing Copyright Statement:

Copyright (c) 2019 Benjamin Torvaney



Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:



The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.



THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.