Merge pull request #268 from nflverse/nflreadr-for-player-stats

Use nflreadr for `load_player_stats`

Author: mrcaseb

DESCRIPTION

@@ -1,7 +1,7 @@
 Type: Package
 Package: nflfastR
 Title: Functions to Efficiently Access NFL Play by Play Data
-Version: 4.2.0.9007
+Version: 4.2.0.9008
 Authors@R: 
     c(person(given = "Sebastian",
              family = "Carl",
@@ -54,7 +54,7 @@ Imports:
     mgcv,
     nflreadr (>= 1.0.0),
     progressr (>= 0.6.0),
-    rlang,
+    rlang (>= 0.4.7),
     stringr (>= 1.3.0),
     tibble (>= 3.0),
     tidyr (>= 1.0.0),

NEWS.md

@@ -2,7 +2,7 @@
 
 * Fixed a minor bug in the console output of `update_db()`
 * Add nflreadr to dependecies and drop lubridate and magrittr dependency
-* The function `load_pbp()` now calls `nflreadr::load_pbp()` internally. Therefore the argument `qs` has been deprecated. It will be removed in a future release.
+* The functions `load_pbp()` and `load_player_stats()` now call `nflreadr::load_pbp()` and `nflreadr::load_player_stats()` respectively. Therefore the argument `qs` has been deprecated in both functions. It will be removed in a future release. Running `load_player_stats()` without any argument will now return player stats of the current season only (the default in `nflreadr`).
 * The deprecated arguments `source` and `pp` in the functions `fast_scraper_*()` and `build_nflfastR_pbp()` have been removed
 * Added the variables `racr` ("Receiver Air Conversion Ratio"), `target_share`, `air_yards_share`, `wopr` ("Weighted Opportunity Rating") and `pacr` ("Passing Air Conversion Ratio") to the output of `calculate_player_stats()`
 * Fix for a handful of missing `receiver` names (#270)

R/load_player_stats.R

@@ -1,11 +1,8 @@
-#' Load Official Game Stats
-#'
-#' @description Loads weekly stats for all passers, rushers and receivers in the
-#' nflfastR play-by-play data from the 1999 season to the most recent season
-#'
-#' @param qs Whether to use the function [qs::qdeserialize()] for more efficient loading.
-#' @return Weekly stats for all passers, rushers and receivers in the nflfastR
-#' play-by-play data from the 1999 season to the most recent season
+#' @inherit nflreadr::load_player_stats
+#' @inheritDotParams nflreadr::load_player_stats
+#' @param qs `r lifecycle::badge("deprecated")` has no effect and will be
+#' removed in a future release.
+#' @param ... Arguments passed on to nflreadr::load_player_stats
 #'
 #' @seealso The function [calculate_player_stats()] and the corresponding examples
 #' on [the nflfastR website](https://www.nflfastr.com/articles/nflfastR.html#example-11-replicating-official-stats)
@@ -15,21 +12,27 @@
 #' dplyr::glimpse(stats)
 #' }
 #' @export
-load_player_stats <- function(qs = FALSE) {
-
-  if (isTRUE(qs) && !is_installed("qs")) {
-    cli::cli_abort("Package {.val qs} required for argument {.val qs = TRUE}. Please install it.")
+load_player_stats <- function(..., qs = lifecycle::deprecated()){
+  if (lifecycle::is_present(qs)) {
+    lifecycle::deprecate_warn(
+      when = "4.3.0",
+      what = "load_pbp(qs = )",
+      details = cli::cli_text("The {.val qs} argument is deprecated and replaced by {.val file_type} - see {.code ?nflreadr::load_player_stats} for details.")
+    )
   }
 
-  if (isTRUE(qs)) {
-    .url <- "https://github.com/nflverse/nflfastR-data/blob/master/data/player_stats.qs?raw=true"
-    out <- qs_from_url(.url)
-  } else {
-    .url <- "https://github.com/nflverse/nflfastR-data/blob/master/data/player_stats.rds?raw=true"
-    con <- url(.url)
-    out <- readRDS(con)
-    close(con)
+  # if the dots are empty, we now have the same behavior like nflreadr which
+  # differs from the previous versions where it was "load all seasons"
+  if (rlang::is_empty(list(...))){
+    cli::cli_warn(
+      c("We have changed the behavior of {.var load_player_stats()} as of nflfastR 4.3.0.",
+        "Calling it without an argument will return the current season only instead of all available seasons.",
+        "Please try {.var load_player_stats(seasons = TRUE)} to get all seasons."
+      ),
+      .frequency = "regularly", .frequency_id = "player_stats_warning"
+    )
   }
 
-  return(out)
+  # if dots are not empty, use them in nflreadr
+  nflreadr::load_player_stats(...)
 }