Adding @family roxygen tag to docs

sportsdataverse · Mar 24, 2023 · 5514178 · 5514178
1 parent 6369cbf
commit 5514178
Show file tree

Hide file tree

Showing 156 changed files with 1,565 additions and 0 deletions.
diff --git a/R/nba_data_pbp.R b/R/nba_data_pbp.R
@@ -66,6 +66,7 @@ NULL
 #' @import furrr
 #' @import rvest
 #' @export
+#' @family NBA PBP Functions
 nba_data_pbp <- function(game_id = "0021900001",
                          ...){
 

diff --git a/R/nba_stats_boxscore.R b/R/nba_stats_boxscore.R
@@ -18,6 +18,7 @@ NULL
 #' @importFrom dplyr filter select rename bind_cols bind_rows as_tibble
 #' @import rvest
 #' @export
+#' @family NBA Boxscore Functions
 #' @details
 #' ```r
 #'  nba_boxscoretraditionalv2(game_id = "0022200021")
@@ -82,6 +83,7 @@ NULL
 #' @importFrom dplyr filter select rename bind_cols bind_rows as_tibble
 #' @import rvest
 #' @export
+#' @family NBA Boxscore Functions
 #' @details
 #' ```r
 #'  nba_boxscoreadvancedv2(game_id = "0022200021")
@@ -141,6 +143,7 @@ NULL
 #' @importFrom dplyr filter select rename bind_cols bind_rows as_tibble
 #' @import rvest
 #' @export
+#' @family NBA Boxscore Functions
 #' @details
 #' ```r
 #'  nba_boxscoredefensive(game_id = "0022200021")
@@ -195,6 +198,7 @@ NULL
 #' @importFrom dplyr filter select rename bind_cols bind_rows as_tibble
 #' @import rvest
 #' @export
+#' @family NBA Boxscore Functions
 #' @details
 #' ```r
 #'  nba_boxscorefourfactorsv2(game_id = "0022200021")
@@ -259,6 +263,7 @@ NULL
 #' @importFrom dplyr filter select rename bind_cols bind_rows as_tibble
 #' @import rvest
 #' @export
+#' @family NBA Boxscore Functions
 #' @details
 #' ```r
 #'  nba_boxscoremiscv2(game_id = "0022200021")
@@ -323,6 +328,7 @@ NULL
 #' @importFrom dplyr filter select rename bind_cols bind_rows as_tibble
 #' @import rvest
 #' @export
+#' @family NBA Boxscore Functions
 #' @details
 #' ```r
 #'  nba_boxscorescoringv2(game_id = "0022200021")
@@ -387,6 +393,7 @@ NULL
 #' @importFrom dplyr filter select rename bind_cols bind_rows as_tibble
 #' @import rvest
 #' @export
+#' @family NBA Boxscore Functions
 #' @details
 #' ```r
 #'  nba_boxscoreusagev2(game_id = "0022200021")
@@ -446,6 +453,7 @@ NULL
 #' @importFrom dplyr filter select rename bind_cols bind_rows as_tibble
 #' @import rvest
 #' @export
+#' @family NBA Boxscore Functions
 #' @details
 #' ```r
 #'  nba_boxscoresummaryv2(game_id = "0022200021")
@@ -496,6 +504,7 @@ NULL
 #' @importFrom dplyr filter select rename bind_cols bind_rows as_tibble
 #' @import rvest
 #' @export
+#' @family NBA Boxscore Functions
 #' @details
 #' ```r
 #'  nba_boxscorematchups(game_id = "0022200021", version = "v1")
@@ -550,6 +559,7 @@ NULL
 #' @importFrom dplyr filter select rename bind_cols bind_rows as_tibble
 #' @import rvest
 #' @export
+#' @family NBA Boxscore Functions, NBA Player Tracking Functions
 #' @details
 #' ```r
 #'  nba_boxscoreplayertrackv2(game_id = "0022200021")
@@ -599,6 +609,7 @@ NULL
 #' @importFrom dplyr filter select rename bind_cols bind_rows as_tibble
 #' @import rvest
 #' @export
+#' @family NBA Boxscore Functions, NBA Hustle Functions
 #' @details
 #' ```r
 #'  nba_hustlestatsboxscore(game_id = "0022200021")
@@ -650,6 +661,7 @@ NULL
 #' @importFrom dplyr filter select rename bind_cols bind_rows as_tibble
 #' @import rvest
 #' @export
+#' @family NBA Boxscore Functions, NBA Lineup Functions
 #' @details
 #' ```r
 #'  nba_gamerotation(game_id = "0022200021")
@@ -718,6 +730,7 @@ NULL
 #' @importFrom dplyr filter select rename bind_cols bind_rows as_tibble
 #' @import rvest
 #' @export
+#' @family NBA Boxscore Similarity Functions
 nba_boxscoresimilarityscore <- function(
     person_1_id,
     person_1_league_id,
@@ -784,6 +797,7 @@ NULL
 #' @importFrom dplyr filter select rename bind_cols bind_rows as_tibble
 #' @import rvest
 #' @export
+#' @family NBA Boxscore Similarity Functions
 nba_glalumboxscoresimilarityscore <- function(
     person_1_id,
     person_1_league_id,

diff --git a/R/nba_stats_cume.R b/R/nba_stats_cume.R
@@ -17,6 +17,7 @@ NULL
 #' @importFrom dplyr filter select rename bind_cols bind_rows as_tibble
 #' @import rvest
 #' @export
+#' @family NBA Cume Functions
 #' @details
 #' [CUME Stats](https://www.nba.com/stats/cumestats)
 #' ```r
@@ -86,6 +87,7 @@ NULL
 #' @importFrom dplyr filter select rename bind_cols bind_rows as_tibble
 #' @import rvest
 #' @export
+#' @family NBA Cume Functions
 #' @details
 #' [CUME Stats](https://www.nba.com/stats/cumestats)
 #' ```r
@@ -156,6 +158,7 @@ NULL
 #' @importFrom dplyr filter select rename bind_cols bind_rows as_tibble
 #' @import rvest
 #' @export
+#' @family NBA Cume Functions
 #' @details
 #' [CUME Stats](https://www.nba.com/stats/cumestats)
 #' ```r
@@ -223,6 +226,7 @@ NULL
 #' @importFrom dplyr filter select rename bind_cols bind_rows as_tibble
 #' @import rvest
 #' @export
+#' @family NBA Cume Functions
 #' @details
 #' [CUME Stats](https://www.nba.com/stats/cumestats)
 #' ```r

diff --git a/R/nba_stats_draft.R b/R/nba_stats_draft.R
@@ -20,6 +20,7 @@ NULL
 #' @importFrom dplyr filter select rename bind_cols bind_rows as_tibble
 #' @import rvest
 #' @export
+#' @family NBA Draft Functions
 #' @details
 #' ```r
 #'  nba_draftboard(season = most_recent_nba_season() - 1)
@@ -85,6 +86,7 @@ NULL
 #' @importFrom dplyr filter select rename bind_cols bind_rows as_tibble
 #' @import rvest
 #' @export
+#' @family NBA Draft Functions
 #' @details
 #' ```r
 #'  nba_draftcombinestats(season_year = most_recent_nba_season() - 1)
@@ -137,6 +139,7 @@ NULL
 #' @importFrom dplyr filter select rename bind_cols bind_rows as_tibble
 #' @import rvest
 #' @export
+#' @family NBA Draft Functions
 #' @details
 #' [Draft Combine](https://www.nba.com/stats/draft/combine)
 #' ```r
@@ -191,6 +194,7 @@ NULL
 #' @importFrom dplyr filter select rename bind_cols bind_rows as_tibble
 #' @import rvest
 #' @export
+#' @family NBA Draft Functions
 #' @details
 #' [Draft Combine Non-stationary Shooting](https://www.nba.com/stats/draft/combine-non-stationary)
 #' ```r
@@ -245,6 +249,7 @@ NULL
 #' @importFrom dplyr filter select rename bind_cols bind_rows as_tibble
 #' @import rvest
 #' @export
+#' @family NBA Draft Functions
 #' @details
 #' [Draft Combine Player Anthro](https://www.nba.com/stats/draft/combine)
 #' ```r
@@ -298,6 +303,7 @@ NULL
 #' @importFrom dplyr filter select rename bind_cols bind_rows as_tibble
 #' @import rvest
 #' @export
+#' @family NBA Draft Functions
 #' @details
 #' [Draft Combine Spot Shooting](https://www.nba.com/stats/draft/combine-spot-up)
 #' ```r
@@ -355,6 +361,7 @@ nba_draftcombinespotshooting <- function(
 #' @importFrom dplyr filter select rename bind_cols bind_rows as_tibble
 #' @import rvest
 #' @export
+#' @family NBA Draft Functions
 #' @details
 #' [Draft History](https://www.nba.com/stats/draft/history)
 #' ```r

diff --git a/R/nba_stats_hustle.R b/R/nba_stats_hustle.R
@@ -37,6 +37,7 @@ NULL
 #' @importFrom dplyr filter select rename bind_cols bind_rows as_tibble
 #' @import rvest
 #' @export
+#' @family NBA Hustle Functions
 #' @details
 #' [Player Hustle Stats](https://www.nba.com/stats/players/hustle)
 #' ```r
@@ -164,6 +165,7 @@ NULL
 #' @importFrom dplyr filter select rename bind_cols bind_rows as_tibble
 #' @import rvest
 #' @export
+#' @family NBA Hustle Functions
 #' @details
 #' [Player Hustle Stats Leaders](https://www.nba.com/stats/players/hustle-leaders)
 #' ```r
@@ -289,6 +291,7 @@ NULL
 #' @importFrom dplyr filter select rename bind_cols bind_rows as_tibble
 #' @import rvest
 #' @export
+#' @family NBA Hustle Functions
 #' @details
 #' [Team Hustle Stats](https://www.nba.com/stats/teams/hustle)
 #' ```r
@@ -414,6 +417,7 @@ NULL
 #' @importFrom dplyr filter select rename bind_cols bind_rows as_tibble
 #' @import rvest
 #' @export
+#' @family NBA Hustle Functions
 #' @details
 #' [Team Hustle Stats Leaders](https://www.nba.com/stats/teams/hustle-leaders)
 #' ```r

diff --git a/R/nba_stats_leaders.R b/R/nba_stats_leaders.R
@@ -16,6 +16,7 @@ NULL
 #' @importFrom dplyr filter select rename bind_cols bind_rows as_tibble
 #' @import rvest
 #' @export
+#' @family NBA Leaders Functions
 #' @details
 #' ```r
 #'  nba_alltimeleadersgrids(league_id = '00')
@@ -78,6 +79,7 @@ NULL
 #' @importFrom dplyr filter select rename bind_cols bind_rows as_tibble
 #' @import rvest
 #' @export
+#' @family NBA Leaders Functions
 #' @details
 #' ```r
 #'  nba_assistleaders(league_id = '00', player_or_team = "Player")
@@ -139,6 +141,7 @@ NULL
 #' @importFrom dplyr filter select rename bind_cols bind_rows as_tibble
 #' @import rvest
 #' @export
+#' @family NBA Leaders Functions
 #' @details
 #' ```r
 #'  nba_assisttracker(league_id = '00')
@@ -198,6 +201,7 @@ NULL
 #' @importFrom dplyr filter select rename bind_cols bind_rows as_tibble
 #' @import rvest
 #' @export
+#' @family NBA Leaders Functions
 #' @details
 #' ```r
 #'  nba_homepageleaders(league_id = '00', player_or_team = "Player")
@@ -271,6 +275,7 @@ NULL
 #' @importFrom dplyr filter select rename bind_cols bind_rows as_tibble
 #' @import rvest
 #' @export
+#' @family NBA Leaders Functions
 #' @details
 #' ```r
 #'  nba_homepagev2(league_id = '00', player_or_team = "Player")
@@ -344,6 +349,7 @@ NULL
 #' @importFrom dplyr filter select rename bind_cols bind_rows as_tibble
 #' @import rvest
 #' @export
+#' @family NBA Leaders Functions
 #' @details
 #' ```r
 #'  nba_leaderstiles(league_id = '00', player_or_team = "Player")
@@ -417,6 +423,7 @@ NULL
 #' @importFrom dplyr filter select rename bind_cols bind_rows as_tibble
 #' @import rvest
 #' @export
+#' @family NBA Leaders Functions
 #' @details
 #' ```r
 #'  nba_defensehub(league_id = '00', player_or_team = "Player")
@@ -489,6 +496,7 @@ NULL
 #' @importFrom dplyr filter select rename bind_cols bind_rows as_tibble
 #' @import rvest
 #' @export
+#' @family NBA Leaders Functions
 #' @details
 #' [League Leaders](https://www.nba.com/stats/leaders)
 #' ```r

diff --git a/R/nba_stats_league.R b/R/nba_stats_league.R
@@ -20,6 +20,7 @@ NULL
 #' @importFrom dplyr filter select rename bind_cols bind_rows as_tibble
 #' @import rvest
 #' @export
+#' @family NBA League Functions
 #' @details
 #' [Player/Team Boxscores](https://www.nba.com/stats/players/boxscores)
 #' ```r
@@ -91,6 +92,7 @@ NULL
 #' @importFrom dplyr filter select rename bind_cols bind_rows as_tibble
 #' @import rvest
 #' @export
+#' @family NBA League Functions
 #' @details
 #' [League Standings](https://www.nba.com/standings)
 #' ```r
@@ -152,6 +154,7 @@ NULL
 #' @importFrom dplyr filter select rename bind_cols bind_rows as_tibble
 #' @import rvest
 #' @export
+#' @family NBA League Functions
 #' @details
 #' [League Standings](https://www.nba.com/standings)
 #' ```r
@@ -213,6 +216,7 @@ NULL
 #' @importFrom dplyr filter select rename bind_cols bind_rows as_tibble
 #' @import rvest
 #' @export
+#' @family NBA League Functions
 nba_playoffpicture <- function(
     league_id = '00',
     season_id = '22022',
@@ -348,6 +352,7 @@ NULL
 #' @importFrom dplyr filter select rename bind_cols bind_rows as_tibble
 #' @import rvest
 #' @export
+#' @family NBA League Functions, NBA Game Finder Functions
 #' @details
 #' ```r
 #'  nba_leaguegamefinder(league_id = '00', season = year_to_season(most_recent_nba_season() - 1))