prepare cran v5

.github/workflows/pkgdown.yaml

@@ -24,7 +24,7 @@ jobs:
       isPush: ${{ github.event_name == 'push' || github.event_name == 'workflow_dispatch' }}
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - uses: r-lib/actions/setup-pandoc@v2
 
@@ -56,7 +56,7 @@ jobs:
 
       - name: Deploy to GitHub pages 🚀
         if: github.event_name != 'pull_request'
-        uses: JamesIves/github-pages-deploy-action@v4.4.1
+        uses: JamesIves/github-pages-deploy-action@v4.5.0
         with:
           clean: false
           branch: gh-pages

CRAN-SUBMISSION

@@ -0,0 +1,3 @@
+Version: 5.0.0
+Date: 2024-11-26 20:40:18 UTC
+SHA: 9e4581c6b5fdb3582a65de80b354d271bc3ad685

DESCRIPTION

@@ -1,7 +1,7 @@
 Type: Package
 Package: nflfastR
 Title: Functions to Efficiently Access NFL Play by Play Data
-Version: 4.6.1.9020
+Version: 5.0.0
 Authors@R: 
     c(person(given = "Sebastian",
              family = "Carl",

NEWS.md

@@ -1,4 +1,11 @@
-# nflfastR (development version)
+# nflfastR 5.0.0
+
+## Major Changes
+
+- 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)
+- 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)
+
+## Bug Fixes and Minor Changes
 
 - Drop `{crayon}`, `{DT}`, `{httr}`, `{jsonlite}`, `{qs}` dependencies. (#453)
 - The function `calculate_player_stats_def` now returns `season_type` if argument `weekly` is set to `TRUE` for consistency with the other player stats functions. (#455)
@@ -12,15 +19,16 @@
 - `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)
 - The variable `penalty_type` now correctly lists the penalty "Kickoff Short of Landing Zone" introduced in the 2024 season. (#486)
 - Fixed a bug where `ep` was incorrect on PAT attempts preceded by a timeout and then a penalty (extremely rare). This bug also caused the variables `total_home_epa` and `total_away_epa` to be incorrect for all subsequent plays in the same game. (#493)
 
+Thank you to
+[&#x0040;ahmed-cheema](https://github.com/ahmed-cheema), [&#x0040;andrewtek](https://github.com/andrewtek), [&#x0040;guga31bb](https://github.com/guga31bb), [&#x0040;isaactpetersen](https://github.com/isaactpetersen), [&#x0040;JoeMarino2021](https://github.com/JoeMarino2021), [&#x0040;john-b-edwards](https://github.com/john-b-edwards), [&#x0040;marcusSasser](https://github.com/marcusSasser), [&#x0040;mlounsberry](https://github.com/mlounsberry), [&#x0040;morganandrew](https://github.com/morganandrew), [&#x0040;mrcaseb](https://github.com/mrcaseb), [&#x0040;mscoop16](https://github.com/mscoop16), [&#x0040;parsnipz](https://github.com/parsnipz), [&#x0040;rjthompson2](https://github.com/rjthompson2), and [&#x0040;Useight](https://github.com/Useight) for their questions, feedback, and contributions towards this release.
+
 # nflfastR 4.6.1
 
 - The function `calculate_series_conversion_rates()` now correctly aggregates season level conversion rates. Performance has also been improved. (#440)

R/nflfastR-package.R

@@ -50,7 +50,7 @@
 #' inherits(future::plan(), "sequential")
 #' ```
 #' For more information on possible plans please see
-#' [the future package Readme](https://github.com/HenrikBengtsson/future/blob/develop/README.md).
+#' [the future package Readme](https://github.com/futureverse/future/blob/develop/README.md).
 #'
 #' For more information on `.Renviron` please see
 #' [this book chapter](https://rstats.wtf/r-startup.html).

R/utils.R

@@ -202,7 +202,7 @@ fetch_raw <- function(game_id,
 release_bullets <- function() {
   c(
     '`devtools::check_mac_release()`',
-    '`rhub::check_for_cran(email = "[email protected]", show_status = FALSE)`',
+    '`rhub::rhub_check(platforms = rhub::rhub_platforms()$name[rhub::rhub_platforms()$name != "rchk"])`',
     '`pkgdown::check_pkgdown()`',
     '`usethis::use_tidy_thanks()`',
     NULL

README.Rmd

@@ -72,7 +72,7 @@ Even though `nflfastR` is very fast, **we recommend downloading the data from [h
 
 ## nflfastR models
 
-`nflfastR` uses its own models for Expected Points, Win Probability, Completion Probability, and Expected Yards After the Catch. To read about the models, please see [this post on Open Source Football](https://opensourcefootball.com/posts/2020-09-28-nflfastr-ep-wp-and-cp-models/). For a more detailed description of the motivation for Expected Points models, we highly recommend this paper [from the nflscrapR team located here](https://arxiv.org/pdf/1802.00998.pdf). 
+`nflfastR` uses its own models for Expected Points, Win Probability, Completion Probability, and Expected Yards After the Catch. To read about the models, please see [this post on Open Source Football](https://opensourcefootball.com/posts/2020-09-28-nflfastr-ep-wp-and-cp-models/). For a more detailed description of the motivation for Expected Points models, we highly recommend this paper [from the nflscrapR team located here](http://arxiv.org/pdf/1802.00998). 
 
 Here is a visualization of the Expected Points model by down and yardline.
 

README.md

@@ -100,7 +100,7 @@ about the models, please see [this post on Open Source
 Football](https://opensourcefootball.com/posts/2020-09-28-nflfastr-ep-wp-and-cp-models/).
 For a more detailed description of the motivation for Expected Points
 models, we highly recommend this paper [from the nflscrapR team located
-here](https://arxiv.org/pdf/1802.00998.pdf).
+here](http://arxiv.org/pdf/1802.00998).
 
 Here is a visualization of the Expected Points model by down and
 yardline.

cran-comments.md

@@ -1,7 +1,7 @@
 ## Release summary
 
-This is a minor release that 
-* adjusts the setup process of unit tests per request
+This is a major release that 
+* adds new functions, deprecates old functions.
 
 ## R CMD check results