From 447c35b025020ce0a70b6eefef50a9da807343fc Mon Sep 17 00:00:00 2001 From: saiemgilani Date: Thu, 6 Apr 2023 15:08:30 -0400 Subject: [PATCH] update docs/tests for `load_mbb_player_box()` --- R/load_mbb.R | 95 ++++++++++++++--------- man/load_mbb_player_box.Rd | 61 ++++++++++----- tests/testthat/test-load_mbb_player_box.R | 1 + 3 files changed, 101 insertions(+), 56 deletions(-) diff --git a/R/load_mbb.R b/R/load_mbb.R index 82f6bf3f..78bda420 100644 --- a/R/load_mbb.R +++ b/R/load_mbb.R @@ -218,42 +218,63 @@ NULL #' @param tablename The name of the play by play data table within the database #' @return Returns a tibble #' -#' |col_name |types | -#' |:-----------------------------|:---------| -#' |athlete_display_name |character | -#' |team_short_display_name |character | -#' |min |character | -#' |fg |character | -#' |fg3 |character | -#' |ft |character | -#' |oreb |character | -#' |dreb |character | -#' |reb |character | -#' |ast |character | -#' |stl |character | -#' |blk |character | -#' |to |character | -#' |pf |character | -#' |pts |character | -#' |starter |logical | -#' |ejected |logical | -#' |did_not_play |logical | -#' |active |logical | -#' |athlete_jersey |character | -#' |athlete_id |character | -#' |athlete_short_name |character | -#' |athlete_headshot_href |character | -#' |athlete_position_name |character | -#' |athlete_position_abbreviation |character | -#' |team_name |character | -#' |team_logo |character | -#' |team_id |character | -#' |team_abbreviation |character | -#' |team_color |character | -#' |game_id |integer | -#' |season |integer | -#' |season_type |integer | -#' |game_date |Date | +#' |col_name |types | +#' |:---------------------------------|:---------| +#' |game_id |integer | +#' |season |integer | +#' |season_type |integer | +#' |game_date |Date | +#' |game_date_time |POSIXct | +#' |athlete_id |integer | +#' |athlete_display_name |character | +#' |team_id |integer | +#' |team_name |character | +#' |team_location |character | +#' |team_short_display_name |character | +#' |minutes |numeric | +#' |field_goals_made |integer | +#' |field_goals_attempted |integer | +#' |three_point_field_goals_made |integer | +#' |three_point_field_goals_attempted |integer | +#' |free_throws_made |integer | +#' |free_throws_attempted |integer | +#' |offensive_rebounds |integer | +#' |defensive_rebounds |integer | +#' |rebounds |integer | +#' |assists |integer | +#' |steals |integer | +#' |blocks |integer | +#' |turnovers |integer | +#' |fouls |integer | +#' |points |integer | +#' |starter |logical | +#' |ejected |logical | +#' |did_not_play |logical | +#' |active |logical | +#' |athlete_jersey |character | +#' |athlete_short_name |character | +#' |athlete_headshot_href |character | +#' |athlete_position_name |character | +#' |athlete_position_abbreviation |character | +#' |team_display_name |character | +#' |team_uid |character | +#' |team_slug |character | +#' |team_logo |character | +#' |team_abbreviation |character | +#' |team_color |character | +#' |team_alternate_color |character | +#' |home_away |character | +#' |team_winner |logical | +#' |team_score |integer | +#' |opponent_team_id |integer | +#' |opponent_team_name |character | +#' |opponent_team_location |character | +#' |opponent_team_display_name |character | +#' |opponent_team_abbreviation |character | +#' |opponent_team_logo |character | +#' |opponent_team_color |character | +#' |opponent_team_alternate_color |character | +#' |opponent_team_score |integer | #' #' @import furrr #' @export @@ -377,6 +398,8 @@ NULL #' |groups_short_name |character | #' |groups_is_conference |logical | #' |tournament_id |numeric | +#' |game_date_time |POSIXct | +#' |game_date |Date | #' |PBP |logical | #' |team_box |logical | #' |player_box |logical | diff --git a/man/load_mbb_player_box.Rd b/man/load_mbb_player_box.Rd index 86998725..b53fe791 100644 --- a/man/load_mbb_player_box.Rd +++ b/man/load_mbb_player_box.Rd @@ -24,40 +24,61 @@ the season data into a database (used by \code{update_mbb_db()}).} \value{ Returns a tibble\tabular{ll}{ col_name \tab types \cr + game_id \tab integer \cr + season \tab integer \cr + season_type \tab integer \cr + game_date \tab Date \cr + game_date_time \tab POSIXct \cr + athlete_id \tab integer \cr athlete_display_name \tab character \cr + team_id \tab integer \cr + team_name \tab character \cr + team_location \tab character \cr team_short_display_name \tab character \cr - min \tab character \cr - fg \tab character \cr - fg3 \tab character \cr - ft \tab character \cr - oreb \tab character \cr - dreb \tab character \cr - reb \tab character \cr - ast \tab character \cr - stl \tab character \cr - blk \tab character \cr - to \tab character \cr - pf \tab character \cr - pts \tab character \cr + minutes \tab numeric \cr + field_goals_made \tab integer \cr + field_goals_attempted \tab integer \cr + three_point_field_goals_made \tab integer \cr + three_point_field_goals_attempted \tab integer \cr + free_throws_made \tab integer \cr + free_throws_attempted \tab integer \cr + offensive_rebounds \tab integer \cr + defensive_rebounds \tab integer \cr + rebounds \tab integer \cr + assists \tab integer \cr + steals \tab integer \cr + blocks \tab integer \cr + turnovers \tab integer \cr + fouls \tab integer \cr + points \tab integer \cr starter \tab logical \cr ejected \tab logical \cr did_not_play \tab logical \cr active \tab logical \cr athlete_jersey \tab character \cr - athlete_id \tab character \cr athlete_short_name \tab character \cr athlete_headshot_href \tab character \cr athlete_position_name \tab character \cr athlete_position_abbreviation \tab character \cr - team_name \tab character \cr + team_display_name \tab character \cr + team_uid \tab character \cr + team_slug \tab character \cr team_logo \tab character \cr - team_id \tab character \cr team_abbreviation \tab character \cr team_color \tab character \cr - game_id \tab integer \cr - season \tab integer \cr - season_type \tab integer \cr - game_date \tab Date \cr + team_alternate_color \tab character \cr + home_away \tab character \cr + team_winner \tab logical \cr + team_score \tab integer \cr + opponent_team_id \tab integer \cr + opponent_team_name \tab character \cr + opponent_team_location \tab character \cr + opponent_team_display_name \tab character \cr + opponent_team_abbreviation \tab character \cr + opponent_team_logo \tab character \cr + opponent_team_color \tab character \cr + opponent_team_alternate_color \tab character \cr + opponent_team_score \tab integer \cr } } \description{ diff --git a/tests/testthat/test-load_mbb_player_box.R b/tests/testthat/test-load_mbb_player_box.R index dd686c1d..5e2546cc 100644 --- a/tests/testthat/test-load_mbb_player_box.R +++ b/tests/testthat/test-load_mbb_player_box.R @@ -37,6 +37,7 @@ test_that("hoopR Loader MBB Player Box", { "active", "athlete_jersey", "athlete_short_name", + "athlete_headshot_href", "athlete_position_name", "athlete_position_abbreviation", "team_display_name",