Release/0.3.0 cran update (#449)

* Update examples to `dontrun` for CRAN

* Update documentation

* reformat NEWS.md and update wordlist

* Add .onLoad to ensure that CRAN checks don't yuse more than 2 CPUs

Author: AlexAxthelm

NEWS.md

@@ -1,7 +1,7 @@
 # r2dii.analysis 0.3.0
 
-# `target_sda` now uses final year of scenario as convergence target when `by_company = TRUE` (#445).
-# `target_market_share` gains argument `increasing_or_decreasing` (#426).
+* `target_sda` now uses final year of scenario as convergence target when `by_company = TRUE` (#445).
+* `target_market_share` gains argument `increasing_or_decreasing` (#426).
 
 # r2dii.analysis 0.2.1
 

R/join_ald_scenario.R

@@ -11,6 +11,7 @@
 #' @export
 #'
 #' @examples
+#' \dontrun{
 #' installed <- requireNamespace("r2dii.data", quietly = TRUE) &&
 #'   requireNamespace("r2dii.match", quietly = TRUE) &&
 #'   packageVersion("r2dii.match") >= "0.1.0"
@@ -38,6 +39,7 @@
 #'       region_isos = region_isos_demo
 #'     )
 #' }
+#' }
 join_ald_scenario <- function(data,
                               ald,
                               scenario,

R/r2dii.analysis-package.R

@@ -1,6 +1,15 @@
 #' @keywords internal
 "_PACKAGE"
 
+.onLoad <- function(libname, pkgname) {
+  # CRAN OMP THREAD LIMIT
+  # logic for setting OMP_THREAD_LIMIT form https://stackoverflow.com/a/77323812
+  # check modified from testthat's on_cran function
+  if (!interactive() && isFALSE(as.logical(Sys.getenv("NOT_CRAN", "false")))) {
+    Sys.setenv("OMP_THREAD_LIMIT" = 2)
+  }
+}
+
 # The following block is used by usethis to automatically manage
 # roxygen namespace tags. Modify with care!
 ## usethis namespace: start

R/summarize_weighted_production.R

@@ -27,6 +27,7 @@
 #'   `summarize_weighted_percent_change()`, respectively.
 #'
 #' @examples
+#' \dontrun{
 #' installed <- requireNamespace("r2dii.data", quietly = TRUE) &&
 #'   requireNamespace("r2dii.match", quietly = TRUE) &&
 #'   packageVersion("r2dii.match") >= "0.1.0"
@@ -55,6 +56,7 @@
 #'
 #'   summarize_weighted_percent_change(master, use_credit_limit = TRUE)
 #' }
+#' }
 summarize_weighted_production <- function(data, ..., use_credit_limit = FALSE) {
   summarize_weighted_production_(data, ..., use_credit_limit = use_credit_limit, with_targets = FALSE)
 }

R/target_market_share.R

@@ -33,6 +33,7 @@
 #' @family functions to calculate scenario targets
 #'
 #' @examples
+#' \dontrun{
 #' installed <- requireNamespace("r2dii.data", quietly = TRUE) &&
 #'   requireNamespace("r2dii.match", quietly = TRUE) &&
 #'   packageVersion("r2dii.match") >= "0.1.0"
@@ -74,6 +75,7 @@
 #'       weight_production = FALSE
 #'     )
 #' }
+#' }
 target_market_share <- function(data,
                                 abcd,
                                 scenario,

R/target_sda.R

@@ -33,6 +33,7 @@
 #' @family functions to calculate scenario targets
 #'
 #' @examples
+#' \dontrun{
 #' installed <- requireNamespace("r2dii.match", quietly = TRUE) &&
 #'   requireNamespace("r2dii.data", quietly = TRUE) &&
 #'   packageVersion("r2dii.match") >= "0.1.0"
@@ -65,7 +66,7 @@
 #'       by_company = TRUE
 #'     )
 #' }
-#'
+#' }
 target_sda <- function(data,
                        abcd,
                        co2_intensity_scenario,

inst/WORDLIST

@@ -6,6 +6,7 @@ Codecov
 Decarbonization
 IKI
 Lifecycle
+Metaprogramming
 ORCID
 PACTA
 PACTA’
@@ -14,13 +15,15 @@ SDA
 Sectoral
 WRI
 WWF
+abcd
 ald
 decarbonization
 dev
 dfrac
 dii
 dplyr
 eval
+favour
 frac
 funder
 funders
@@ -34,6 +37,7 @@ roadmaps
 rstudio
 sectoral
 smsp
+summarise
 tibble
 tidyverse
 tmsr