Merge pull request #29 from nflverse/cran-v1.0.4

create user cache directory with tools

CRAN-SUBMISSION

@@ -0,0 +1,3 @@
+Version: 1.0.4
+Date: 2023-08-18 14:05:13 UTC
+SHA: 9a0222a689b872afef2864b5c45d27554a0b9182

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: nfl4th
 Title: Functions to Calculate Optimal Fourth Down Decisions in the National Football League
-Version: 1.0.3
+Version: 1.0.4
 Authors@R: 
     c(person(given = "Ben",
              family = "Baldwin",
@@ -14,11 +14,12 @@ Description: A set of functions to estimate outcomes of fourth down
     plays in the National Football League and obtain fourth down plays
     from <https://www.nfl.com/> and <https://www.espn.com/>.
 License: MIT + file LICENSE
-URL: https://www.nfl4th.com/, https://github.com/nflverse/nfl4th/
+URL: https://www.nfl4th.com/, https://github.com/nflverse/nfl4th/, https://github.com/nflverse/nfl4th
 BugReports: https://github.com/nflverse/nfl4th/issues
 Depends: 
     R (>= 3.6)
 Imports: 
+    backports (>= 1.1.6),
     curl,
     dplyr,
     glue,
@@ -30,7 +31,6 @@ Imports:
     nflfastR (>= 4.0.0),
     nflreadr,
     purrr,
-    rappdirs,
     rlang,
     stringr,
     tibble,

NAMESPACE

@@ -7,11 +7,15 @@ export(load_4th_pbp)
 export(make_2pt_table_data)
 export(make_table_data)
 export(nfl4th_clear_cache)
+if (getRversion() >= "4.0.0") {
+  importFrom(tools, R_user_dir)
+} else {
+  importFrom(backports, R_user_dir)
+}
 import(dplyr)
 importFrom(glue,glue)
 importFrom(magrittr,"%>%")
 importFrom(nflfastR,calculate_win_probability)
-importFrom(rappdirs,user_cache_dir)
 importFrom(rlang,arg_match)
 importFrom(stringr,str_replace_all)
 importFrom(tidyr,pivot_wider)

NEWS.md

@@ -1,3 +1,7 @@
+# nfl4th 1.0.4
+
+* Create package cache directory with `tools::R_user_dir()` because CRAN doesn't like `rappdirs::user_cache_dir()`
+
 # nfl4th 1.0.3
 
 * Re-export xgboost models to get rid of annoying warning message

R/cache.R

@@ -1,25 +1,28 @@
 # paths are defined in zzz.R
 # these helpers read games or fd_model and save them to a package cache
 
-nfl4th_games_path <- function()   file.path(rappdirs::user_cache_dir("nfl4th", "nflverse"), "games_nfl4th.rds")
-nfl4th_fdmodel_path <- function() file.path(rappdirs::user_cache_dir("nfl4th", "nflverse"), "fd_model.rds")
-nfl4th_wpmodel_path <- function() file.path(rappdirs::user_cache_dir("nfl4th", "nflverse"), "wp_model.rds")
+nfl4th_games_path <- function()   file.path(R_user_dir("nfl4th", "cache"), "games_nfl4th.rds")
+nfl4th_fdmodel_path <- function() file.path(R_user_dir("nfl4th", "cache"), "fd_model.rds")
+nfl4th_wpmodel_path <- function() file.path(R_user_dir("nfl4th", "cache"), "wp_model.rds")
 
 .games_nfl4th <- function(){
+  if (probably_cran() && !force_cache()) return(get_games_file())
   if (!file.exists(nfl4th_games_path())){
     saveRDS(get_games_file(), nfl4th_games_path())
   }
   readRDS(nfl4th_games_path())
 }
 
 fd_model <- function(){
+  if (probably_cran() && !force_cache()) return(load_fd_model())
   if (!file.exists(nfl4th_fdmodel_path())){
     saveRDS(load_fd_model(), nfl4th_fdmodel_path())
   }
   readRDS(nfl4th_fdmodel_path())
 }
 
 wp_model <- function(){
+  if (probably_cran() && !force_cache()) return(load_wp_model())
   if (!file.exists(nfl4th_wpmodel_path())){
     saveRDS(load_wp_model(), nfl4th_wpmodel_path())
   }
@@ -52,3 +55,17 @@ nfl4th_clear_cache <- function(type = c("games", "fd_model", "wp_model", "all"))
   file.remove(to_delete[file.exists(to_delete)])
   invisible(TRUE)
 }
+
+# The env var _R_CHECK_EXAMPLE_TIMING_CPU_TO_ELAPSED_THRESHOLD_ is mostly
+# a CRAN env var. We use it to decide if the code likely is running on CRAN
+probably_cran <- function(){
+  cpu_threshold <- Sys.getenv(
+    "_R_CHECK_EXAMPLE_TIMING_CPU_TO_ELAPSED_THRESHOLD_", NA_character_
+    )
+  !is.na(cpu_threshold)
+}
+
+# allow user to force the cache even if probably_cran() is TRUE
+force_cache <- function() {
+  getOption("nfl4th.force_cache", "false") == "true"
+}

R/nfl4th-package.R

@@ -8,11 +8,15 @@
 #' @importFrom glue glue
 #' @importFrom magrittr %>%
 #' @importFrom nflfastR calculate_win_probability
-#' @importFrom rappdirs user_cache_dir
 #' @importFrom rlang arg_match
 #' @importFrom stringr str_replace_all
 #' @importFrom tidyr pivot_wider
 #' @importFrom tidyselect any_of
 #' @importFrom xgboost getinfo
+#' @rawNamespace if (getRversion() >= "4.0.0") {
+#'   importFrom(tools, R_user_dir)
+#' } else {
+#'   importFrom(backports, R_user_dir)
+#' }
 ## usethis namespace: end
 NULL

R/zzz.R

@@ -1,15 +1,17 @@
 .onLoad <- function(libname,pkgname){
-
+
+  backports::import(pkgname, "R_user_dir")
+
   is_online <- !is.null(curl::nslookup("github.com", error = FALSE))
   keep_games <- isTRUE(getOption("nfl4th.keep_games", FALSE))
-  
-  if(!is_online && !keep_games) rlang::warn("GitHub.com seems offline, and `options(nfl4th.keep_games)` is not set to TRUE. Deleting the games cache, and predictions may not be available without an internet connection.") 
-  
+
+  if(!is_online && !keep_games) rlang::warn("GitHub.com seems offline, and `options(nfl4th.keep_games)` is not set to TRUE. Deleting the games cache, and predictions may not be available without an internet connection.")
+
   if(!is_online && keep_games) rlang::warn("GitHub.com seems offline, and `options(nfl4th.keep_games)` is set to TRUE. To get updates, clear the games cache with `nfl4th::nfl4th_clear_cache()`")
 
   # create package cache directory if it doesn't exist
-  if (!dir.exists(rappdirs::user_cache_dir("nfl4th", "nflverse"))){
-    dir.create(rappdirs::user_cache_dir("nfl4th", "nflverse"), recursive = TRUE, showWarnings = FALSE)
+  if (!dir.exists(R_user_dir("nfl4th", "cache"))){
+    dir.create(R_user_dir("nfl4th", "cache"), recursive = TRUE, showWarnings = FALSE)
   } else if (file.exists(nfl4th_games_path()) && !keep_games){
     # remove games from package cache on load so it updates
     # only runs if options(nfl4th.keep_games) != TRUE

cran-comments.md

@@ -1,11 +1,9 @@
 ## Release summary
 
-This is a minor release that
-
-* Uses cache to allow the package to function without internet.
-* Removes tidyverse from Suggests
+Create user cache directory with tools instead of rappdirs and make sure it's cleared 
 
 ## Test environments
+
 * Windows Server 2022, R-devel, 64 bit
 * Fedora Linux, R-devel, clang, gfortran
 * Ubuntu Linux 20.04.1 LTS, R-release, GCC