Merge pull request #108 from sportsdataverse/devel

NBA Live & Docs

NAMESPACE

@@ -110,6 +110,7 @@ export(nba_drafthistory)
 export(nba_fantasywidget)
 export(nba_franchisehistory)
 export(nba_franchiseleaders)
+export(nba_franchiseleaderswrank)
 export(nba_franchiseplayers)
 export(nba_gamerotation)
 export(nba_glalumboxscoresimilarityscore)
@@ -143,6 +144,8 @@ export(nba_leagueplayerondetails)
 export(nba_leagueseasonmatchups)
 export(nba_leaguestandings)
 export(nba_leaguestandingsv3)
+export(nba_live_boxscore)
+export(nba_live_pbp)
 export(nba_matchupsrollup)
 export(nba_pbp)
 export(nba_pbps)
@@ -181,6 +184,7 @@ export(nba_scoreboardv2)
 export(nba_shotchartdetail)
 export(nba_shotchartleaguewide)
 export(nba_shotchartlineupdetail)
+export(nba_synergyplaytypes)
 export(nba_teamdashboardbyclutch)
 export(nba_teamdashboardbygamesplits)
 export(nba_teamdashboardbygeneralsplits)
@@ -206,6 +210,7 @@ export(nba_teamplayeronoffsummary)
 export(nba_teamvsplayer)
 export(nba_teamyearbyyearstats)
 export(nba_videodetails)
+export(nba_videodetailsasset)
 export(nba_videoevents)
 export(nba_videostatus)
 export(nba_winprobabilitypbp)

NEWS.md

@@ -1,6 +1,11 @@
 # **hoopR 1.9.1.9000**
 - Add proxy rlang dots option for passing httr::use_proxy() option to `nba_*()` functions
 - ```nba_shotchartlineupdetail()``` function added.
+- ```nba_synergyplaytypes()``` function added.
+- ```nba_live_pbp()``` function added.
+- ```nba_live_boxscore()``` function added.
+- ```nba_franchiseleaderswrank()``` function added.
+- ```nba_videodetailsasset()``` function added.
 
 # **hoopR 1.9.1**
 - Updates under-the-hood urls to the ESPN site API v2 summary endpoints

R/nba_stats_boxscore.R

@@ -1,10 +1,10 @@
 
 #' **Get NBA Stats API Boxscore Traditional V2**
-#' @name bs_trad_v2
+#' @name nba_boxscoretraditionalv2
 NULL
 #' @title
 #' **Get NBA Stats API Boxscore Traditional V2**
-#' @rdname bs_trad_v2
+#' @rdname nba_boxscoretraditionalv2
 #' @author Saiem Gilani
 #' @param game_id Game ID
 #' @param start_period start_period
@@ -61,11 +61,11 @@ nba_boxscoretraditionalv2 <- function(
 }
 
 #' **Get NBA Stats API Boxscore Advanced V2**
-#' @name bs_adv_v2
+#' @name nba_boxscoreadvancedv2
 NULL
 #' @title
 #' **Get NBA Stats API Boxscore Advanced V2**
-#' @rdname bs_adv_v2
+#' @rdname nba_boxscoreadvancedv2
 #' @author Saiem Gilani
 #' @param game_id Game ID
 #' @param start_period start_period
@@ -124,11 +124,11 @@ nba_boxscoreadvancedv2 <- function(
 }
 
 #' **Get NBA Stats API Boxscore Defensive**
-#' @name bs_defensive
+#' @name nba_boxscoredefensive
 NULL
 #' @title
 #' **Get NBA Stats API Boxscore Defensive**
-#' @rdname bs_defensive
+#' @rdname nba_boxscoredefensive
 #' @author Saiem Gilani
 #' @param game_id Game ID
 #' @param ... Additional arguments passed to an underlying function like httr.
@@ -170,11 +170,11 @@ nba_boxscoredefensive <- function(
 }
 
 #' **Get NBA Stats API Boxscore Four Factors V2**
-#' @name bs_ff_v2
+#' @name nba_boxscorefourfactorsv2
 NULL
 #' @title
 #' **Get NBA Stats API Boxscore Four Factors V2**
-#' @rdname bs_ff_v2
+#' @rdname nba_boxscorefourfactorsv2
 #' @author Saiem Gilani
 #' @param game_id Game ID
 #' @param start_period start_period
@@ -231,11 +231,11 @@ nba_boxscorefourfactorsv2 <- function(
 }
 
 #' **Get NBA Stats API Boxscore Misc V2**
-#' @name bs_misc_v2
+#' @name nba_boxscoremiscv2
 NULL
 #' @title
 #' **Get NBA Stats API Boxscore Misc V2**
-#' @rdname bs_misc_v2
+#' @rdname nba_boxscoremiscv2
 #' @author Saiem Gilani
 #' @param game_id Game ID
 #' @param start_period start_period
@@ -292,11 +292,11 @@ nba_boxscoremiscv2 <- function(
 }
 
 #' **Get NBA Stats API Boxscore Scoring V2**
-#' @name bs_scoring_v2
+#' @name nba_boxscorescoringv2
 NULL
 #' @title
 #' **Get NBA Stats API Boxscore Scoring V2**
-#' @rdname bs_scoring_v2
+#' @rdname nba_boxscorescoringv2
 #' @author Saiem Gilani
 #' @param game_id Game ID
 #' @param start_period start_period
@@ -353,11 +353,11 @@ nba_boxscorescoringv2 <- function(
 }
 
 #' **Get NBA Stats API Boxscore Usage V2**
-#' @name bs_usage_v2
+#' @name nba_boxscoreusagev2
 NULL
 #' @title
 #' **Get NBA Stats API Boxscore Usage V2**
-#' @rdname bs_usage_v2
+#' @rdname nba_boxscoreusagev2
 #' @author Saiem Gilani
 #' @param game_id Game ID
 #' @param start_period start_period
@@ -414,11 +414,11 @@ nba_boxscoreusagev2 <- function(
 }
 
 #' **Get NBA Stats API Boxscore Summary V2**
-#' @name bs_summary_v2
+#' @name nba_boxscoresummaryv2
 NULL
 #' @title
 #' **Get NBA Stats API Boxscore Summary V2**
-#' @rdname bs_summary_v2
+#' @rdname nba_boxscoresummaryv2
 #' @author Saiem Gilani
 #' @param game_id Game ID
 #' @param ... Additional arguments passed to an underlying function like httr.
@@ -460,11 +460,11 @@ nba_boxscoresummaryv2 <- function(
 }
 
 #' **Get NBA Stats API Boxscore Matchups**
-#' @name bs_match
+#' @name nba_boxscorematchups
 NULL
 #' @title
 #' **Get NBA Stats API Boxscore Matchups**
-#' @rdname bs_match
+#' @rdname nba_boxscorematchups
 #' @author Saiem Gilani
 #' @param game_id Game ID
 #' @param version Boxscore Matchups version ("v2" available from 2016-17 onwards)
@@ -511,11 +511,11 @@ nba_boxscorematchups <- function(
 }
 
 #' **Get NBA Stats API Boxscore Player Tracking V2**
-#' @name bs_pt_v2
+#' @name nba_boxscoreplayertrackv2
 NULL
 #' @title
 #' **Get NBA Stats API Boxscore Player Tracking V2**
-#' @rdname bs_pt_v2
+#' @rdname nba_boxscoreplayertrackv2
 #' @author Saiem Gilani
 #' @param game_id Game ID
 #' @param ... Additional arguments passed to an underlying function like httr.
@@ -557,11 +557,11 @@ nba_boxscoreplayertrackv2 <- function(
 }
 
 #' **Get NBA Stats API Hustle Stats Boxscore**
-#' @name hustle_bs
+#' @name nba_hustlestatsboxscore
 NULL
 #' @title
 #' **Get NBA Stats API Hustle Stats Boxscore**
-#' @rdname hustle_bs
+#' @rdname nba_hustlestatsboxscore
 #' @author Saiem Gilani
 #' @param game_id Game ID
 #' @param ... Additional arguments passed to an underlying function like httr.
@@ -603,11 +603,11 @@ nba_hustlestatsboxscore <- function(
 }
 
 #' **Get NBA Stats API Game Rotation**
-#' @name game_rotation
+#' @name nba_gamerotation
 NULL
 #' @title
 #' **Get NBA Stats API Game Rotation**
-#' @rdname game_rotation
+#' @rdname nba_gamerotation
 #' @author Saiem Gilani
 #' @param game_id Game ID
 #' @param league_id League ID
@@ -663,11 +663,11 @@ nba_gamerotation <- function(
 }
 
 #' **Get NBA Stats API Boxscore Similarity Score**
-#' @name bs_similarity
+#' @name nba_boxscoresimilarityscore
 NULL
 #' @title
 #' **Get NBA Stats API Boxscore Similarity Score**
-#' @rdname bs_similarity
+#' @rdname nba_boxscoresimilarityscore
 #' @author Saiem Gilani
 #' @param person_1_id person_1_id
 #' @param person_1_league_id person_1_league_id
@@ -726,11 +726,11 @@ nba_boxscoresimilarityscore <- function(
 }
 
 #' **Get NBA Stats API G-League Alum Boxscore Similarity Score**
-#' @name gl_bs_similarity
+#' @name nba_glalumboxscoresimilarityscore
 NULL
 #' @title
 #' **Get NBA Stats API G-League Alum Boxscore Similarity Score**
-#' @rdname gl_bs_similarity
+#' @rdname nba_glalumboxscoresimilarityscore
 #' @author Saiem Gilani
 #' @param person_1_id person_1_id
 #' @param person_1_league_id person_1_league_id

R/nba_stats_cume.R

@@ -1,9 +1,9 @@
 #' **Get NBA Stats API Cumulative Player Stats**
-#' @name cumestatsplayer
+#' @name nba_cumestatsplayer
 NULL
 #' @title
 #' **Get NBA Stats API Cumulative Player Stats**
-#' @rdname cumestatsplayer
+#' @rdname nba_cumestatsplayer
 #' @author Saiem Gilani
 #' @param game_ids game_ids
 #' @param league_id league_id
@@ -17,6 +17,11 @@ NULL
 #' @importFrom dplyr filter select rename bind_cols bind_rows as_tibble
 #' @import rvest
 #' @export
+#' @details
+#' [CUME Stats](https://www.nba.com/stats/cumestats)
+#' ```r
+#'  nba_cumestatsplayer()
+#' ```
 
 nba_cumestatsplayer <- function(
   game_ids = '0022000756',
@@ -57,11 +62,11 @@ nba_cumestatsplayer <- function(
 }
 
 #' **Get NBA Stats API Cumulative Player Game Stats**
-#' @name cumestatsplayergames
+#' @name nba_cumestatsplayergames
 NULL
 #' @title
 #' **Get NBA Stats API Cumulative Player Game Stats**
-#' @rdname cumestatsplayergames
+#' @rdname nba_cumestatsplayergames
 #' @author Saiem Gilani
 #' @param league_id league_id
 #' @param location location
@@ -78,12 +83,17 @@ NULL
 #' @importFrom dplyr filter select rename bind_cols bind_rows as_tibble
 #' @import rvest
 #' @export
+#' @details
+#' [CUME Stats](https://www.nba.com/stats/cumestats)
+#' ```r
+#'  nba_cumestatsplayergames(player_id = '2544')
+#' ```
 nba_cumestatsplayergames <- function(
   league_id = '00',
   location = '',
   outcome = '',
   player_id = '2544',
-  season = '2020-21',
+  season = year_to_season(most_recent_nba_season() - 1),
   season_type = 'Regular Season',
   vs_conference = '',
   vs_division = '',
@@ -123,11 +133,11 @@ nba_cumestatsplayergames <- function(
 }
 
 #' **Get NBA Stats API Cumulative Team Stats**
-#' @name cumestatsteam
+#' @name nba_cumestatsteam
 NULL
 #' @title
 #' **Get NBA Stats API Cumulative Team Stats**
-#' @rdname cumestatsteam
+#' @rdname nba_cumestatsteam
 #' @author Saiem Gilani
 #' @param game_ids game_ids
 #' @param league_id league_id
@@ -140,12 +150,17 @@ NULL
 #' @importFrom dplyr filter select rename bind_cols bind_rows as_tibble
 #' @import rvest
 #' @export
+#' @details
+#' [CUME Stats](https://www.nba.com/stats/cumestats)
+#' ```r
+#'  nba_cumestatsteam()
+#' ```
 nba_cumestatsteam <- function(
   game_ids = '0022000756',
   league_id = '00',
   season = '2020-21',
   season_type = 'Regular Season',
-  team_id = '',
+  team_id = '1610612739',
   ...){
 
   season_type <- gsub(' ','+',season_type)
@@ -177,11 +192,11 @@ nba_cumestatsteam <- function(
   return(df_list)
 }
 #' **Get NBA Stats API Cumulative Team Game Stats**
-#' @name cumestatsteamgames
+#' @name nba_cumestatsteamgames
 NULL
 #' @title
 #' **Get NBA Stats API Cumulative Team Game Stats**
-#' @rdname cumestatsteamgames
+#' @rdname nba_cumestatsteamgames
 #' @author Saiem Gilani
 #' @param league_id league_id
 #' @param location location
@@ -199,11 +214,16 @@ NULL
 #' @importFrom dplyr filter select rename bind_cols bind_rows as_tibble
 #' @import rvest
 #' @export
+#' @details
+#' [CUME Stats](https://www.nba.com/stats/cumestats)
+#' ```r
+#'  nba_cumestatsteamgames()
+#' ```
 nba_cumestatsteamgames <- function(
   league_id = '00',
   location = '',
   outcome = '',
-  season = '2020-21',
+  season = year_to_season(most_recent_nba_season() - 1),
   season_id = '',
   season_type = 'Regular Season',
   team_id = 1610612739,