progress_clear: Clear the visible progress status line

In rtemis.core: Core Utilities for the 'rtemis' Ecosystem

Clear the visible progress status line

Description

Escape hatch for code that is about to write raw console output (e.g. cat(), print(), or a verbose third-party routine) while a progress status line is on screen: clears the line so the output starts clean. The status line reappears on the next progress_update(). No-op when nothing is displayed.

Usage

progress_clear()

Details

Not needed for output that goes through msg() and the other rtemis writers (they clear automatically), nor for message()/warning() conditions raised inside progress_lapply() (a calling handler clears for those). This exists for the one gap that cannot be intercepted: direct writes to stdout.

Value

NULL invisibly.

Author(s)

EDG

See Also

Other progress: progress_begin(), progress_end(), progress_lapply(), progress_update()

Examples

progress_clear() # no-op when no status line is visible

rtemis.core documentation built on Sept. 20, 2026, 9:06 a.m.