This function can be used to conveniently configure the progress bar by
adjusting the progress_bar_config field of the
Options instance in the base::.Options list.
Arguments
- type
A character string specifying the type of progress bar to be used with compatible
backends. Possible values are"modern"and"basic". The default value is"modern".- ...
A list of named arguments used to configure the progress bar. See the Details section for more information.
Details
The optional ... named arguments depend on the type of progress bar being
configured. When type = "modern", the ... take the named arguments of the
progress::progress_bar class. When type = "basic", the ... take the
named arguments of the utils::txtProgressBar() built-in function. See the
Examples section for a demonstration.
Examples
# Set the default package options.
set_default_options()
# Get the progress bar type from options.
get_option("progress_bar_type")
#> [1] "modern"
# Get the progress bar configuration from options.
get_option("progress_bar_config")
#> $modern
#> $modern$show_after
#> [1] 0
#>
#> $modern$format
#> [1] " > completed :current out of :total tasks [:percent] [:elapsed]"
#>
#>
#> $basic
#> list()
#>
# Adjust the format of the `modern` progress bar.
configure_bar(type = "modern", format = "[:bar] :percent")
# Check that the configuration has been updated in the options.
get_option("progress_bar_config")
#> $modern
#> $modern$show_after
#> [1] 0
#>
#> $modern$format
#> [1] "[:bar] :percent"
#>
#>
#> $basic
#> list()
#>
# Change to and adjust the style of the `basic` progress bar.
configure_bar(type = "basic", style = 3)
# Check that the configuration has been updated in the options.
get_option("progress_bar_type")
#> [1] "basic"
get_option("progress_bar_config")
#> $modern
#> $modern$show_after
#> [1] 0
#>
#> $modern$format
#> [1] "[:bar] :percent"
#>
#>
#> $basic
#> $basic$style
#> [1] 3
#>
#>