handler_newline

Progression Handler: Progress Reported as a New Line (Text) in the Terminal

internal

A minimal, unifying API for scripts and packages to report progress updates from anywhere including when using parallel processing.  The package is designed such that the developer can to focus on what progress should be reported on without having to worry about how to present it.  The end user has full control of how, where, and when to render these progress updates, e.g. in the terminal using utils::txtProgressBar(), cli::cli_progress_bar(), in a graphical user interface using utils::winProgressBar(), tcltk::tkProgressBar() or shiny::withProgress(), via the speakers using beepr::beep(), or on a file system via the size of a file. Anyone can add additional, customized, progression handlers. The 'progressr' package uses R's condition framework for signaling progress updated. Because of this, progress can be reported from almost anywhere in R, e.g. from classical for and while loops, from map-reduce API:s like the lapply() family of functions, 'purrr', 'plyr', and 'foreach'. It will also work with parallel processing via the 'future' framework, e.g. future.apply::future_lapply(), furrr::future_map(), and 'foreach' with 'doFuture'. The package is compatible with Shiny applications.

Henrik Bengtsson

progressr

An Inclusive, Unifying API for Progress Updates

handler_newline function

<dl><dt>symbol</dt>
<dd>(character string) The character symbol to be outputted,
which by default is the ASCII NL character (<code>'\n'</code> = <code>'\013'</code>) character.</dd>
<dt>file</dt>
<dd>(connection) A <a href="/link/base%3A%3Aconnection?package=progressr&version=0.15.1" data-mini-rdoc="progressr::base::connection">base::connection</a> to where output should be sent.</dd>
<dt>intrusiveness</dt>
<dd>(numeric) A non-negative scalar on how intrusive
(disruptive) the reporter to the user.</dd>
<dt>target</dt>
<dd>(character vector) Specifies where progression updates are
rendered.</dd>
<dt>...</dt>
<dd>Additional arguments passed to <code>make_progression_handler()</code>.</dd></dl>

Arguments

Progression Handler: Progress Reported as a New Line (Text) in the Terminal — handler_newline

<dl>

<dt>symbol</dt>
<dd>(character string) The character symbol to be outputted,
which by default is the ASCII NL character (<code>'\n'</code> = <code>'\013'</code>) character.</dd>


<dt>file</dt>
<dd>(connection) A <a href='https://rdrr.io/r/base/connections.html'>base::connection</a> to where output should be sent.</dd>


<dt>intrusiveness</dt>
<dd>(numeric) A non-negative scalar on how intrusive
(disruptive) the reporter to the user.</dd>


<dt>target</dt>
<dd>(character vector) Specifies where progression updates are
rendered.</dd>


<dt>...</dt>
<dd>Additional arguments passed to <code>make_progression_handler()</code>.</dd>

</dl>

handler_newline: Progression Handler: Progress Reported as a New Line (Text) in the Terminal

Description

Usage

Arguments