https://github.com/cran/spatstat
Revision 4fe059206e698a4b7135d792f3d533b173ecfe77 authored by Adrian Baddeley on 16 May 2012, 12:44:15 UTC, committed by cran-robot on 16 May 2012, 12:44:15 UTC
1 parent df59a11
Tip revision: 4fe059206e698a4b7135d792f3d533b173ecfe77 authored by Adrian Baddeley on 16 May 2012, 12:44:15 UTC
version 1.27-0
version 1.27-0
Tip revision: 4fe0592
progressreport.Rd
\name{progressreport}
\alias{progressreport}
\title{Print Progress Reports}
\description{
Prints Progress Reports during a loop or iterative calculation.
}
\usage{
progressreport(i, n, every = max(1, ceiling(n/100)), nperline =
min(charsperline, every * ceiling(charsperline/(every + 3))),
charsperline = 60, style=spatstat.options("progress"))
}
\arguments{
\item{i}{
Integer. The current iteration number (from 1 to \code{n}).
}
\item{n}{
Integer. The (maximum) number of iterations to be computed.
}
\item{every}{
Optional integer. The number of iterations between successive
reports.
}
\item{nperline}{
Optional integer. The maximum number of reports to be printed per
line of output.
}
\item{charsperline}{
Optional integer. The number of characters in a line of output.
}
\item{style}{
Character string determining the style of display.
See Details.
}
}
\details{
This is a convenient function for reporting progress
during an iterative sequence of calculations
or a suite of simulations.
If \code{style="txtbar"} then \code{\link[utils]{txtProgressBar}} is
used to represent progress as a bar made of text characters in the
\R interpreter window.
If \code{style="tty"}, then progress reports are printed using
\code{cat}. This only seems to work well under Linux.
}
\value{
Null.
}
\author{Adrian Baddeley
\email{Adrian.Baddeley@csiro.au}
\url{http://www.maths.uwa.edu.au/~adrian/}
and Rolf Turner
\email{r.turner@auckland.ac.nz}
}
\examples{
for(i in 1:40) progressreport(i, 40)
}
\keyword{print}
Computing file changes ...