/ggshakeR

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

Primary LanguageRMIT LicenseMIT

ggshakeR

Lifecycle: experimental License: MIT check-standard codecov

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:

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:

OK, now how do you get ggshakeR into RStudio?

First install the devtools package:

install.packages("devtools")

After that, write the actual code to install ggshakeR:

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:

devtools::install_github("abhiamishra/ggshakeR@0.1.2")

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:

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:

Credit

Thank you to StatsBomb and Ewan Henderson 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 for your help and your package 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 or at my Twitter

Powered by Chatalytics:tm:

Owner and Creator: Abhishek Amol Mishra

Authors: Harsh Krishna & Ryo Nakagawara

Licenses Used

  • Torvaney and the ggsoccer package has been used in the package for creation of pitches. The use of this adheres to the MIT License 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.