add .for_cran()

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: nflreadr
 Title: Download 'nflverse' Data
-Version: 1.3.2.06
+Version: 1.3.2.07
 Authors@R: c(
     person("Tan", "Ho", , "[email protected]", role = c("aut", "cre", "cph"),
            comment = c(ORCID = "0000-0001-8388-5155")),

NAMESPACE

@@ -2,6 +2,7 @@
 
 S3method(print,nflverse_data)
 export(.clear_cache)
+export(.for_cran)
 export(.sitrep)
 export(clean_homeaway)
 export(clean_player_names)

NEWS.md

@@ -11,6 +11,7 @@ etc falsely returned last season after March 15th early in the month. (1.3.2.03)
 - Clarified description of the `"special"` variable in the play-by-play data dictionary. (1.3.2.04) (#189)
 - `nflreadr::nflverse_game_id()` accepts old team abbreviations and outputs useful errors. (1.3.2.05) (#191)
 - Added `dictionary_player_stats_def` (thank you @mpcen!) (1.3.2.06) (#192)
+- Added `.for_cran()` to limit parallelization in CRAN examples and tests (1.3.2.07)
 
 # nflreadr 1.3.2
 

R/utils_cran.R

@@ -0,0 +1,18 @@
+#' CRAN setup code
+#'
+#' Some code to comply with CRAN policies, e.g.
+#' limiting data.table CPU cores for examples/tests
+#'
+#' @export
+.for_cran <- function(){
+
+  cores <- min(
+    getOption("Ncpus", default = 2L),
+    as.integer(Sys.getenv("OMP_THREAD_LIMIT",unset = "2")),
+    floor(Sys.getenv("_R_CHECK_EXAMPLE_TIMING_CPU_TO_ELAPSED_THRESHOLD_", unset = 2)),
+    2L,
+    na.rm = TRUE
+  )
+
+  data.table::setDTthreads(cores)
+}