fix: cran

DESCRIPTION

@@ -8,7 +8,6 @@ Description: Parallel computing with a network of local and remote
     workers. Fast exchange of results between the workers through a
     'Redis' database. Key features include task queues, local caching, and
     sophisticated error handling.
-License: MIT + file LICENSE
 URL: https://github.com/mlr-org/rush
 BugReports: https://github.com/mlr-org/rush/issues
 Depends:
@@ -33,3 +32,4 @@ Config/testthat/parallel: false
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
 RoxygenNote: 7.3.1
+License: MIT + file LICENSE

LICENSE

@@ -1,2 +1,2 @@
 YEAR: 2024
-COPYRIGHT HOLDER: 2024 mlr-org
+COPYRIGHT HOLDER: rush authors

NAMESPACE

@@ -1,7 +1,6 @@
 # Generated by roxygen2: do not edit by hand
 
 export(AppenderRedis)
-export(Rush)
 export(RushWorker)
 export(assert_rush)
 export(assert_rush_worker)

R/AppenderRedis.R

@@ -25,8 +25,10 @@
 #' @param filters (`list`)\cr
 #' List of filters.
 #'
+#' @return Object of class [R6::R6Class] and `AppenderRedis` with methods for writing log events to Redis data bases.
 #' @export
 #' @examples
+#' # This example is not executed since Redis must be installed
 #' \donttest{
 #'    config_local = redux::redis_config()
 #'

R/Rush.R

@@ -106,8 +106,9 @@
 #' @template param_seed
 #' @template param_data_format
 #'
-#' @export
+#' @return Object of class [R6::R6Class] and `Rush` with controller methods.
 #' @examples
+#' # This example is not executed since Redis must be installed
 #' \donttest{
 #'    config_local = redux::redis_config()
 #'    rush = rsh(network_id = "test_network", config = config_local)

R/RushWorker.R

@@ -17,8 +17,10 @@
 #' @template param_lgr_buffer_size
 #' @template param_seed
 #'
+#' @return Object of class [R6::R6Class] and `RushWorker` with worker methods.
 #' @export
 #' @examples
+#' # This example is not executed since Redis must be installed
 #' \donttest{
 #'    config_local = redux::redis_config()
 #'    rush = rsh(network_id = "test_network", config = config_local)

R/assertions.R

@@ -9,6 +9,7 @@
 #' @name rush_assertions
 #' @keywords internal
 #' @examples
+#' # This example is not executed since Redis must be installed
 #' \donttest{
 #'    config_local = redux::redis_config()
 #'    rush = rsh(network_id = "test_network", config = config_local)

R/heartbeat_loops.R

@@ -19,6 +19,7 @@
 #' @keywords internal
 #' @export
 #' @examples
+#' # This example is not executed since Redis must be installed
 #' \donttest{
 #'    config_local = redux::redis_config()
 #'

R/rush_plan.R

@@ -19,6 +19,7 @@
 #' @return `list()` with the stored configuration.
 #' @export
 #' @examples
+#' # This example is not executed since Redis must be installed
 #' \donttest{
 #'    config_local = redux::redis_config()
 #'    rush_plan(config = config_local, n_workers = 2)
@@ -59,6 +60,7 @@ rush_plan = function(
 #'
 #' @export
 #' @examples
+#' # This example is not executed since Redis must be installed
 #' \donttest{
 #'   config_local = redux::redis_config()
 #'   rush_plan(config = config_local, n_workers = 2)
@@ -78,8 +80,10 @@ rush_config = function() {
 #' @description
 #' Removes the rush plan that was set by [rush_plan()].
 #'
+#' @return Invisible `TRUE`. Function called for side effects.
 #' @export
 #' @examples
+#' # This example is not executed since Redis must be installed
 #' \donttest{
 #'   config_local = redux::redis_config()
 #'   rush_plan(config = config_local, n_workers = 2)
@@ -99,6 +103,7 @@ remove_rush_plan = function() {
 #'
 #' @export
 #' @examples
+#' # This example is not executed since Redis must be installed
 #' \donttest{
 #'   config_local = redux::redis_config()
 #'   rush_plan(config = config_local, n_workers = 2)

R/start_worker.R

@@ -21,6 +21,7 @@
 #' @return `NULL`
 #' @export
 #' @examples
+#' # This example is not executed since Redis must be installed
 #' \dontrun{
 #'   rush::start_worker(
 #'    network_id = 'test-rush',

R/sugar.R

@@ -10,6 +10,7 @@
 #' @return [Rush] controller.
 #' @export
 #' @examples
+#' # This example is not executed since Redis must be installed
 #' \donttest{
 #'    config_local = redux::redis_config()
 #'    rush = rsh(network_id = "test_network", config = config_local)

R/worker_loops.R

@@ -15,6 +15,7 @@
 #' @return `NULL`
 #' @export
 #' @examples
+#' # This example is not executed since Redis must be installed
 #' \donttest{
 #'    config_local = redux::redis_config()
 #'    rush = rsh(network_id = "test_network", config = config_local)
@@ -63,6 +64,7 @@ worker_loop_default = function(fun, constants = NULL, rush) {
 #' @return `NULL`
 #' @export
 #' @examples
+#' # This example is not executed since Redis must be installed
 #' \donttest{
 #'    config_local = redux::redis_config()
 #'    rush = rsh(network_id = "test_network", config = config_local)