spatstat (version 1.31-3)

progressreport: Print Progress Reports

Description

Prints Progress Reports during a loop or iterative calculation.

Usage

progressreport(i, n,
               every = min(100,max(1, ceiling(n/100))),
               nperline = min(charsperline,
                              every * ceiling(charsperline/(every + 3))),
               charsperline = 60,
               style=spatstat.options("progress"))

Arguments

i

Integer. The current iteration number (from 1 to n).

n

Integer. The (maximum) number of iterations to be computed.

every

Optional integer. The number of iterations between successive reports.

nperline

Optional integer. The maximum number of reports to be printed per line of output.

charsperline

Optional integer. The number of characters in a line of output.

style

Character string determining the style of display. See Details.

Value

• Null.

Details

This is a convenient function for reporting progress during an iterative sequence of calculations or a suite of simulations.

If style="txtbar" then txtProgressBar is used to represent progress as a bar made of text characters in the Rinterpreter window.

If style="tty", then progress reports are printed using cat. This only seems to work well under Linux.

Examples

for(i in 1:40) progressreport(i, 40)