Add new function calculate_stats()

DESCRIPTION

@@ -1,7 +1,7 @@
 Type: Package
 Package: nflfastR
 Title: Functions to Efficiently Access NFL Play by Play Data
-Version: 4.6.1.9018
+Version: 4.6.1.9019
 Authors@R: 
     c(person(given = "Sebastian",
              family = "Carl",
@@ -51,6 +51,7 @@ Imports:
     future,
     glue,
     janitor,
+    lifecycle,
     mgcv,
     nflreadr (>= 1.2.0),
     progressr (>= 0.6.0),
@@ -63,7 +64,6 @@ Imports:
 Suggests: 
     DBI,
     gsisdecoder,
-    lifecycle (>= 0.2.0),
     nflseedR (>= 1.0.2),
     purrr (>= 0.3.0),
     rmarkdown,

NAMESPACE

@@ -10,6 +10,7 @@ export(calculate_player_stats_def)
 export(calculate_player_stats_kicking)
 export(calculate_series_conversion_rates)
 export(calculate_standings)
+export(calculate_stats)
 export(calculate_win_probability)
 export(clean_pbp)
 export(decode_player_ids)
@@ -27,6 +28,7 @@ import(dplyr)
 import(fastrmodels)
 importFrom(cli,rule)
 importFrom(curl,curl_fetch_memory)
+importFrom(data.table,"%between%")
 importFrom(data.table,"%chin%")
 importFrom(data.table,setDT)
 importFrom(furrr,future_map)
@@ -36,11 +38,13 @@ importFrom(future,plan)
 importFrom(glue,glue)
 importFrom(glue,glue_sql)
 importFrom(janitor,clean_names)
+importFrom(lifecycle,deprecated)
 importFrom(mgcv,predict.bam)
 importFrom(nflreadr,nflverse_sitrep)
 importFrom(progressr,progressor)
 importFrom(rlang,":=")
 importFrom(rlang,.data)
+importFrom(rlang,.env)
 importFrom(rlang,dots_list)
 importFrom(rlang,inform)
 importFrom(stats,na.omit)

NEWS.md

@@ -12,6 +12,9 @@
 - `punter_player_id`, and `punter_player_name` are filled for blocked punt attempts. (#463)
 - Fixed an issue affecting scores of 2022 games involving a return touchdown (#466)
 - Added identification of scrambles from 1999 through 2004 with thank to Aaron Schatz (#468, #489)
+- Added new function `calculate_stats()` that combines the output of all `calculate_player_stats*()` functions with a more robust and faster approach. The `calculate_player_stats*()` function will be deprecated in a future release. (#470)
+- Updated the dataframe `stat_ids` with some IDs that were previously missing. (#470)
+- Added new exported dataframe `nfl_stats_variables`. It lists and explains all variables returned by `calculate_stats()`. A searchable table is available at <https://www.nflfastr.com/articles/stats_variables.html>. (#470)
 - nflfastR tried to fix bugs in the underlying pbp data of JAX home games prior to the 2016 season. An update of the raw pbp data resolved those bugs so nflfastR needs to remove the hard coded adjustments. This means that nflfastR <= v4.6.1 will return incorrect pbp data for all Jacksonville home games prior to the 2016 season! (#478)
 - Fixed a problem where `clean_pbp()` returned `pass = 1` in actual rush plays in very rare cases. (#479)
 - Removed extra lines for injury timeouts that were breaking `fixed_drive` (#482)

R/aggregate_game_stats.R

@@ -5,6 +5,12 @@
 
 #' Get Official Game Stats
 #'
+#' @description
+#' `r lifecycle::badge("deprecated")`
+#'
+#' This function was deprecated because we have a new, much better and
+#' harmonized approach in [`calculate_stats()`].
+#'
 #' @param pbp A Data frame of NFL play-by-play data typically loaded with
 #' [load_pbp()] or [build_nflfastR_pbp()]. If the data doesn't include the variable
 #' `qb_epa`, the function `add_qb_epa()` will be called to add it.
@@ -84,6 +90,7 @@
 #' \item{fantasy_points_ppr}{PPR fantasy points.}
 #' }
 #' @export
+#' @keywords internal
 #' @seealso The function [load_player_stats()] and the corresponding examples
 #' on [the nflfastR website](https://www.nflfastr.com/articles/nflfastR.html#example-11-replicating-official-stats)
 #' @examples
@@ -100,6 +107,12 @@
 #' }
 calculate_player_stats <- function(pbp, weekly = FALSE) {
 
+  lifecycle::deprecate_warn(
+    "5.0",
+    "calculate_player_stats()",
+    "calculate_stats()"
+  )
+
   # need newer version of nflreadr to use load_players
   rlang::check_installed("nflreadr (>= 1.3.0)", "to join player information.")
 

R/aggregate_game_stats_def.R

@@ -5,6 +5,12 @@
 
 #' Get Official Game Stats on Defense
 #'
+#' @description
+#' `r lifecycle::badge("deprecated")`
+#'
+#' This function was deprecated because we have a new, much better and
+#' harmonized approach in [`calculate_stats()`].
+#'
 #' @param pbp A Data frame of NFL play-by-play data typically loaded with
 #'   [load_pbp()] or [build_nflfastR_pbp()]. If the data doesn't include the variable
 #'   `qb_epa`, the function `add_qb_epa()` will be called to add it.
@@ -14,6 +20,7 @@
 #'   either at the game level or at the level of the entire data frame passed.
 #' @return A data frame of defensive player stats. See dictionary (# TODO)
 #' @export
+#' @keywords internal
 #' @seealso The function [load_player_stats()] and the corresponding examples
 #' on [the nflfastR website](https://www.nflfastr.com/articles/nflfastR.html#example-11-replicating-official-stats)
 #' @examples
@@ -59,6 +66,12 @@
 
 calculate_player_stats_def <- function(pbp, weekly = FALSE) {
 
+  lifecycle::deprecate_warn(
+    "5.0",
+    "calculate_player_stats_def()",
+    "calculate_stats()"
+  )
+
   # need newer version of nflreadr to use load_players
   rlang::check_installed("nflreadr (>= 1.3.0)")
 

R/aggregate_game_stats_kicking.R

@@ -1,6 +1,12 @@
 #' Summarize Kicking Stats
 #'
-#' @description Build columns that aggregate kicking stats at the game level.
+#' @description
+#' `r lifecycle::badge("deprecated")`
+#'
+#' This function was deprecated because we have a new, much better and
+#' harmonized approach in [`calculate_stats()`].
+#'
+#' Build columns that aggregate kicking stats at the game level.
 #'
 #' @param pbp A Data frame of NFL play-by-play data typically loaded with
 #' [load_pbp()] or [build_nflfastR_pbp()].
@@ -22,8 +28,15 @@
 #' @return a dataframe of kicking stats
 #' @seealso <https://nflreadr.nflverse.com/reference/load_player_stats.html> for the nflreadr function to download this from repo (`stat_type = "kicking"`)
 #' @export
+#' @keywords internal
 calculate_player_stats_kicking <- function(pbp, weekly = FALSE) {
 
+  lifecycle::deprecate_warn(
+    "5.0",
+    "calculate_player_stats_kicking()",
+    "calculate_stats()"
+  )
+
   # need newer version of nflreadr to use load_players
   rlang::check_installed("nflreadr (>= 1.3.0)")