progress

Simple command line progress bar
15 Downloads
Updated 27 Sep 2019

## Usage

`progress('_start')` initializes a new progress bar. Must always be called first.

`progress(i)` updates the progress bar. `i` is a percentage.

`progress(i, m)` is similar, but a percentage is automagically calculated, where `i` is the current step and `m` the maximum number of steps.

`progress('_end')` ends the progress bar.

`progress('_erase')` ends the progress bar and removes if from the command window, restoring it to the way it was before the progress bar was initiated.

`progress(message)` ends the progress bar and adds message after the bar.

`progress(..., opts)` uses options from the struct opts. See below.

## Options

`opts.percentageLength`: sets the number of characters reserved for the percentage display (default: 5)

`opts.barLength`: sets the number of characters reserved for the progress bar (default: 48)

`opts.charEmpty`: sets the "empty" character (default: '.')

`opts.charFilled`: sets the "filled" character (default: '#')

Cite As

Yarmo Mackenbach (2024). progress (https://github.com/YarmoM/progress), GitHub. Retrieved .

MATLAB Release Compatibility
Created with R2010a
Compatible with any release
Platform Compatibility
Windows macOS Linux
Tags Add Tags

Community Treasure Hunt

Find the treasures in MATLAB Central and discover how the community can help you!

Start Hunting!

Versions that use the GitHub default branch cannot be downloaded

Version Published Release Notes
1.0.1

To view or report issues in this GitHub add-on, visit the GitHub Repository.
To view or report issues in this GitHub add-on, visit the GitHub Repository.