R/package.R

In bwlewis/future.redis: An Elastic Distributed Computing Backend for the Future Package

#' future.redis: An elastic distributed computing backend for the future package.
#'
#' The \pkg{future.redis} package implements the Future API
#' using the Redis key/value database to define partially fault-tolerant task
#' queues for elastic distributed computing.
#'
#' @examples
#' \donttest{
#' if (redux::redis_available()) {
#' ## The example assumes that a Redis server is running on the local host
#' ## and standard port.
#' plan(redis)
#' startLocalWorkers(2, linger=1)
#' demo("mandelbrot", package = "future", ask = FALSE)
#' removeQ()
#' }
#' }
#'
#' @docType package
#' @useDynLib future.redis, .registration=TRUE, .fixes="C_"
#' @aliases future.redis-package
#' @name future.redis
NULL