progressInfo: Displays the Progress Info

In numeract/shinyXT: Extensible Table Framework for Shiny

Description

Displays progress info taking into account the mode the user is in. If the quiet mode is activated, the function call doesn't display anything. If the user is in console mode, the progress information is printed on the console. If the function is called in a valid Shiny session, a default progress bar shows progress information.

Usage

progressInfo(message, detail = "Begin", max = 10L, shiny_session = NULL,
  quiet = FALSE)

Arguments

message	Character, the message to be displayed to the user. NULL in order to hide the current message
detail	Character, the detail to be displayed to the user. If the user is in a Shiny session, detail message will be shown with a de-emphasized appearance relative to message
max	Numeric, value that represents the end of the progress bar
shiny_session	The shiny session object, provided by shinyServer
quiet	Logical, whether or not to display progress info

Value

A list with progress functions to call:

name inc(detail)	Increment progress counter
name set(detail = NULL, value = NULL)	Set progress counter to value
name close(detail = "Done")	Terminate the progress bar. Best if called from on.exit().

numeract/shinyXT documentation built on May 30, 2019, 5 a.m.