Skip to content

Latest commit

 

History

History
141 lines (101 loc) · 6.87 KB

README.md

File metadata and controls

141 lines (101 loc) · 6.87 KB

hoopR

CRAN status CRAN downloads Version-Number R-CMD-check Lifecycle:maturing

Contributors

hoopR is an R package for working with men’s basketball data.

The package has functions to access live play by play and box score data from ESPN with shot locations when available. As of version 1.3.0, hoopR is also a full NBA Stats API wrapper with 127 functions added in this release.

It is additionally a scraping and aggregating interface for Ken Pomeroy’s men’s college basketball statistics website, kenpom.com. It provides users with an active subscription the capability to scrape the website tables and analyze the data for themselves.

Installation

You can install the CRAN version of hoopR with:

install.packages("hoopR")

You can install the released version of hoopR from GitHub with:

# 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/hoopR", dependencies = TRUE, update = TRUE)

Quick Start

NBA full play-by-play seasons (2002-2024) ~ 1-2 minutes

tictoc::tic()
progressr::with_progress({
  nba_pbp <- hoopR::load_nba_pbp()
})
tictoc::toc()
## 1.02 sec elapsed

## 109783 rows of NBA play-by-play data from 230 games.

Men’s college basketball full play-by-play seasons (2006-2024) ~ 2-3 minutes

tictoc::tic()
progressr::with_progress({
  mbb_pbp <-  hoopR::load_mbb_pbp()
})
tictoc::toc()
## 1.62 sec elapsed

## 360517 rows of men's college basketball play-by-play data from 1074 games.

Documentation

For more information on the package and function reference, please see the hoopR documentation website.

Breaking Changes

Full News on Releases

Follow the SportsDataverse (@SportsDataverse) on Twitter and star this repo

GitHub stars

Our Authors

  • Saiem Gilani (@saiemgilani)

@saiemgilani

Our Contributors (they’re awesome)

  • Jason Lee (@theFirmAISports)

    @papagorgio23

  • Billy Fryer (@_b4billy_)

    @billyfryer

  • Ross Drucker (@rossdrucker9)

    @rossdrucker

  • Vladislav Shufinskiy (@vshufinskiy)

    @shufinskiy

Citations

To cite the hoopR R package in publications, use:

BibTex Citation

@misc{gilani_2021_hoopR,
  author = {Gilani, Saiem},
  title = {hoopR: The SportsDataverse's R Package for Men's Basketball Data.},
  url = {https://hoopR.sportsdataverse.org},
  year = {2021}
}