File: iterCount.Rd

package info (click to toggle)
r-cran-pkgmaker 0.32.10-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,192 kB
  • sloc: sh: 13; makefile: 2
file content (37 lines) | stat: -rw-r--r-- 764 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/logging.R
\name{iterCount}
\alias{iterCount}
\title{Simple Text Iteration Counter}
\usage{
iterCount(n = 100, i0 = 0L, title = "Iterations", extra = NULL, verbose = TRUE)
}
\arguments{
\item{n}{number of total steps}

\item{i0}{starting step}

\item{title}{character string to use as title}

\item{extra}{character vector providing extra text to add at each step}

\item{verbose}{logical that toggles the counter}
}
\value{
A function that can be used to increment progress.
}
\description{
Simple Text Iteration Counter
}
\examples{

progress <- iterCount(LETTERS)
res <- sapply(LETTERS, function(x){
 Sys.sleep(.1)
	progress()
})
# terminate counter
i_end <- progress(NULL)
i_end 

}