redis_progress_bar: Progress bar generator function

In cturbelin/redisProgress: Follow Task Progression using Redis

Description

Holds the environment containing progress bar data For one task instance

Usage

redis_progress_bar(name, redis, debug = FALSE)

Arguments

name	progress name prefix
redis	redis_client() results
debug	debug mode

Value

progress bar structure (list with function)

progress-bar

The progress bar instance is currently a very simple object-mimic list exposing several functions

start

Start a task

incr

Increment the step value

step

Set the current step value

message

Send a message

task

get the task name

queue

get the queue name

value

get the current step value

Parameters of these functions (if any), are described in the following sections

start(taskname, steps=0, init = 0, modulo=NULL)

Declare the starting of a task

taskname

Name of the starting task (cannot contain colon character)

steps

Total number of steps of the task

init

Initial step value

step_task(value)

Define the current task step to be value

message(msg)

Send a message

get the queue name get the value

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