redis_progress_monitor: Monitor Progress of a tasks queue

Description Usage Arguments Options from Parameter Examples

View source: R/monitor.R

Description

This function provides a minimal console based interface to follow the progression of tasks in a queue One 'queue' can follows an arbitrary number of tasks run in parallel.

Usage

1

Arguments

from

source of the queue to monitor, simplest is the queue name (without the queue prefix)

redis

redis client definition object, returned by redis_client()

options

list (see section options)

debug

show verbose information message if TRUE (for development)

Options

use.bar

use progress bar

bar.size

size of the progress bar (number of chars)

steps

number of steps of all the tasks (if always the same and not provided by each task)

ncol

number of columns to use to show the tasks progress

sleep

number of seconds to sleep between update

log.size

number of log messages to show (only lasts)

from Parameter

from parameter can be either a single character value,

key

redis key where the current queue name is stored in case of publish strategy

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
## Not run: 
# Follow the progress of the queue named "queue1"
redis_progress_monitor("queue1")

# Following tasks published in a list
redis_progress_monitor(list(key="myqueues"))

# Using progress bar and show only the 10 last log messages
redis_progress_monitor(from=queue1, options=list(use.bar=TRUE, log.size=10))

## End(Not run)

cturbelin/redisProgress documentation built on Dec. 10, 2019, 7:35 a.m.