progress_bar: progress_bar

In shinyhttr: Progress Bars for Downloads in 'shiny' Apps

Description

Same as 'httr:::progress_bar()' but with capability to talk to 'shinyWidgets::progressBar()'.

Usage

progress_bar(
  type,
  con,
  session,
  id,
  title = NULL,
  status = NULL,
  range_value = NULL,
  unit_mark = "%"
)

Arguments

type	(from 'httr::progress()' doc) Type of progress to display: either number of bytes uploaded or downloaded.
con	(from 'httr::progress()' doc) Connection to send output too. Usually stdout() or stderr.
session	(from ‘shinyWidgets::updateProgressBar()' doc) The ’session' object passed to function given to shinyServer.
id	(from 'shinyWidgets::updateProgressBar()' doc) An id used to update the progress bar.
title	(from 'shinyWidgets::updateProgressBar()' doc) character, optional title.
status	(from 'shinyWidgets::updateProgressBar()' doc) Color, must be a valid Bootstrap status : primary, info, success, warning, danger.
range_value	(from 'shinyWidgets::updateProgressBar()' doc) Default is to display percentage ([0, 100]), but you can specify a custom range, e.g. -50, 50.
unit_mark	(from 'shinyWidgets::updateProgressBar()' doc) Unit for value displayed on the progress bar, default to "%".

Value

a function with rules to print out the progress.

See Also

progress, progressBar

shinyhttr documentation built on July 16, 2020, 5:07 p.m.