Skip to content

Commit

Permalink
Adding @shufinskiy to contributors, description and intro/readme
Browse files Browse the repository at this point in the history
  • Loading branch information
saiemgilani committed Nov 25, 2023
1 parent 8e217ec commit 4990f62
Show file tree
Hide file tree
Showing 9 changed files with 67 additions and 22 deletions.
8 changes: 6 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Package: hoopR
Title: Access Men's Basketball Play by Play Data
Version: 2.0.1
Version: 2.1.0
Authors@R:
c(person(given = "Saiem",
family = "Gilani",
Expand All @@ -17,7 +17,11 @@ Authors@R:
person(given = "Ross",
family = "Drucker",
role = c("ctb"),
email = "[email protected]"))
email = "[email protected]"),
person(given = "Vladislav",
family = "Shufinskiy",
role = c("ctb"),
email = "[email protected]"))
Description: A utility to quickly obtain clean and tidy men's
basketball play by play data. Provides functions to access
live play by play and box score data from ESPN<https://www.espn.com> with shot locations
Expand Down
5 changes: 5 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# **hoopR 2.1.0**
* ```load_nba_*()``` functions now use `sportsdataverse-data` releases url instead of `hoopR-data` repository URL
* ```load_mbb_*()``` functions now use `sportsdataverse-data` releases url instead of `hoopR-data` repository URL
- ```nba_pbp()``` and ```nba_pbps()``` functions add parameter `on_court` (default `TRUE`) to return on-court players for each play event, courtesy of [\@shufinskiy](https://github.com/shufinskiy)

# **hoopR 2.0.0**

### **NBA Stats API Live Endpoints**
Expand Down
4 changes: 4 additions & 0 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,10 @@ For more information on the package and function reference, please see the [**`
<a href="https://twitter.com/rossdrucker9" target="blank"><img src="https://img.shields.io/twitter/follow/rossdrucker9?color=blue&label=%40rossdrucker9&logo=twitter&style=for-the-badge" alt="@rossdrucker9" /></a>
<a href="https://github.com/rossdrucker" target="blank"><img src="https://img.shields.io/github/followers/rossdrucker?color=eee&logo=Github&style=for-the-badge" alt="@rossdrucker" /></a>

- [Vladislav Shufinskiy](https://twitter.com/vshufinskiy)
<a href="https://twitter.com/vshufinskiy" target="blank"><img src="https://img.shields.io/twitter/follow/vshufinskiy?color=blue&label=%40vshufinskiy&logo=twitter&style=for-the-badge" alt="@vshufinskiy" /></a>
<a href="https://github.com/shufinskiy" target="blank"><img src="https://img.shields.io/github/followers/shufinskiy?color=eee&logo=Github&style=for-the-badge" alt="@shufinskiy" /></a>

## **Citations**

To cite the [**`hoopR`**](https://hoopR.sportsdataverse.org) R package in publications, use:
Expand Down
40 changes: 22 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ pacman::p_load_current_gh("sportsdataverse/hoopR", dependencies = TRUE, update =

## Quick Start

### **NBA full play-by-play seasons (2002-2023) \~ 1-2 minutes**
### **NBA full play-by-play seasons (2002-2024) ~ 1-2 minutes**

``` r
tictoc::tic()
Expand All @@ -66,11 +66,11 @@ progressr::with_progress({
tictoc::toc()
```

## 5.23 sec elapsed
## 1.19 sec elapsed

## 546926 rows of NBA play-by-play data from 1161 games.
## 105107 rows of NBA play-by-play data from 220 games.

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

``` r
tictoc::tic()
Expand All @@ -80,9 +80,9 @@ progressr::with_progress({
tictoc::toc()
```

## 17.72 sec elapsed
## 1.64 sec elapsed

## 1956490 rows of men's college basketball play-by-play data from 6113 games.
## 339256 rows of men's college basketball play-by-play data from 1010 games.

## **Documentation**

Expand All @@ -105,23 +105,27 @@ stars](https://img.shields.io/github/stars/sportsdataverse/hoopR.svg?color=eee&l

## **Our Authors**

- [Saiem Gilani](https://twitter.com/saiemgilani)
<a href="https://twitter.com/saiemgilani" target="blank"><img src="https://img.shields.io/twitter/follow/saiemgilani?color=blue&label=%40saiemgilani&logo=twitter&style=for-the-badge" alt="@saiemgilani" /></a>
<a href="https://github.com/saiemgilani" target="blank"><img src="https://img.shields.io/github/followers/saiemgilani?color=eee&logo=Github&style=for-the-badge" alt="@saiemgilani" /></a>
- [Saiem Gilani](https://twitter.com/saiemgilani)
<a href="https://twitter.com/saiemgilani" target="blank"><img src="https://img.shields.io/twitter/follow/saiemgilani?color=blue&label=%40saiemgilani&logo=twitter&style=for-the-badge" alt="@saiemgilani" /></a>
<a href="https://github.com/saiemgilani" target="blank"><img src="https://img.shields.io/github/followers/saiemgilani?color=eee&logo=Github&style=for-the-badge" alt="@saiemgilani" /></a>

## **Our Contributors (they’re awesome)**

- [Jason Lee](https://twitter.com/theFirmAISports)
<a href="https://twitter.com/theFirmAISports" target="blank"><img src="https://img.shields.io/twitter/follow/theFirmAISports?color=blue&label=%40theFirmAISports&logo=twitter&style=for-the-badge" alt="@theFirmAISports" /></a>
<a href="https://github.com/papagorgio23" target="blank"><img src="https://img.shields.io/github/followers/papagorgio23?color=eee&logo=Github&style=for-the-badge" alt="@papagorgio23" /></a>
- [Jason Lee](https://twitter.com/theFirmAISports)
<a href="https://twitter.com/theFirmAISports" target="blank"><img src="https://img.shields.io/twitter/follow/theFirmAISports?color=blue&label=%40theFirmAISports&logo=twitter&style=for-the-badge" alt="@theFirmAISports" /></a>
<a href="https://github.com/papagorgio23" target="blank"><img src="https://img.shields.io/github/followers/papagorgio23?color=eee&logo=Github&style=for-the-badge" alt="@papagorgio23" /></a>

- [Billy Fryer](https://twitter.com/_b4billy_)
<a href="https://twitter.com/_b4billy_" target="blank"><img src="https://img.shields.io/twitter/follow/_b4billy_?color=blue&label=%40_b4billy_&logo=twitter&style=for-the-badge" alt="@_b4billy_" /></a>
<a href="https://github.com/billyfryer" target="blank"><img src="https://img.shields.io/github/followers/billyfryer?color=eee&logo=Github&style=for-the-badge" alt="@billyfryer" /></a>
- [Billy Fryer](https://twitter.com/_b4billy_)
<a href="https://twitter.com/_b4billy_" target="blank"><img src="https://img.shields.io/twitter/follow/_b4billy_?color=blue&label=%40_b4billy_&logo=twitter&style=for-the-badge" alt="@_b4billy_" /></a>
<a href="https://github.com/billyfryer" target="blank"><img src="https://img.shields.io/github/followers/billyfryer?color=eee&logo=Github&style=for-the-badge" alt="@billyfryer" /></a>

- [Ross Drucker](https://twitter.com/rossdrucker9)
<a href="https://twitter.com/rossdrucker9" target="blank"><img src="https://img.shields.io/twitter/follow/rossdrucker9?color=blue&label=%40rossdrucker9&logo=twitter&style=for-the-badge" alt="@rossdrucker9" /></a>
<a href="https://github.com/rossdrucker" target="blank"><img src="https://img.shields.io/github/followers/rossdrucker?color=eee&logo=Github&style=for-the-badge" alt="@rossdrucker" /></a>
- [Ross Drucker](https://twitter.com/rossdrucker9)
<a href="https://twitter.com/rossdrucker9" target="blank"><img src="https://img.shields.io/twitter/follow/rossdrucker9?color=blue&label=%40rossdrucker9&logo=twitter&style=for-the-badge" alt="@rossdrucker9" /></a>
<a href="https://github.com/rossdrucker" target="blank"><img src="https://img.shields.io/github/followers/rossdrucker?color=eee&logo=Github&style=for-the-badge" alt="@rossdrucker" /></a>

- [Vladislav Shufinskiy](https://twitter.com/vshufinskiy)
<a href="https://twitter.com/vshufinskiy" target="blank"><img src="https://img.shields.io/twitter/follow/vshufinskiy?color=blue&label=%40vshufinskiy&logo=twitter&style=for-the-badge" alt="@vshufinskiy" /></a>
<a href="https://github.com/shufinskiy" target="blank"><img src="https://img.shields.io/github/followers/shufinskiy?color=eee&logo=Github&style=for-the-badge" alt="@shufinskiy" /></a>

## **Citations**

Expand Down
3 changes: 3 additions & 0 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@ authors:
href: https://twitter.com/_b4billy_
Ross Drucker:
href: https://twitter.com/rossdrucker9
Vladislav Shufinskiy:
href: https://twitter.com/vshufinskiy
home:
title: hoopR • Data and Tools for Men's Basketball
description: >
Expand Down Expand Up @@ -247,3 +249,4 @@ reference:
- '`helper_espn_mbb_pbp`'
- '`helper_espn_mbb_team_box`'
- '`helper_espn_mbb_player_box`'
- '`.players_on_court`'
1 change: 1 addition & 0 deletions man/hoopR-package.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 11 additions & 1 deletion tests/testthat/test-nba_pbp.R
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,17 @@ test_that("NBA PBP", {
"player3_team_nickname",
"player3_team_abbreviation",
"video_available_flag",
"team_leading"
"team_leading",
"away_player1",
"away_player2",
"away_player3",
"away_player4",
"away_player5",
"home_player1",
"home_player2",
"home_player3",
"home_player4",
"home_player5"
)


Expand Down
12 changes: 11 additions & 1 deletion tests/testthat/test-nba_pbps.R
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,17 @@ test_that("NBA PBPs", {
"player3_team_nickname",
"player3_team_abbreviation",
"video_available_flag",
"team_leading"
"team_leading",
"away_player1",
"away_player2",
"away_player3",
"away_player4",
"away_player5",
"home_player1",
"home_player2",
"home_player3",
"home_player4",
"home_player5"
)


Expand Down
4 changes: 4 additions & 0 deletions vignettes/getting-started-hoopR.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -177,3 +177,7 @@ dplyr::glimpse(mbb_player_box)
<a href="https://twitter.com/rossdrucker9" target="blank"><img src="https://img.shields.io/twitter/follow/rossdrucker9?color=blue&label=%40rossdrucker9&logo=twitter&style=for-the-badge" alt="@rossdrucker9" /></a>
<a href="https://github.com/rossdrucker" target="blank"><img src="https://img.shields.io/github/followers/rossdrucker?color=eee&logo=Github&style=for-the-badge" alt="@rossdrucker" /></a>

- [Vladislav Shufinskiy](https://twitter.com/vshufinskiy)
<a href="https://twitter.com/vshufinskiy" target="blank"><img src="https://img.shields.io/twitter/follow/vshufinskiy?color=blue&label=%40vshufinskiy&logo=twitter&style=for-the-badge" alt="@vshufinskiy" /></a>
<a href="https://github.com/shufinskiy" target="blank"><img src="https://img.shields.io/github/followers/shufinskiy?color=eee&logo=Github&style=for-the-badge" alt="@shufinskiy" /></a>

0 comments on commit 4990f62

Please sign in to comment.