File: setProgress.ProgressBar.Rd

package info (click to toggle)
r-cran-r.utils 2.13.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,864 kB
  • sloc: sh: 18; makefile: 6
file content (43 lines) | stat: -rw-r--r-- 1,136 bytes parent folder | download | duplicates (5)
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
38
39
40
41
42
43
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Do not modify this file since it was automatically generated from:
% 
%  ProgressBar.R
% 
% by the Rdoc compiler part of the R.oo package.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\name{setProgress.ProgressBar}
\alias{setProgress.ProgressBar}
\alias{ProgressBar.setProgress}
\alias{setProgress,ProgressBar-method}

\title{Sets current progress}

\description{
  Sets current progress.
}

\usage{
\method{setProgress}{ProgressBar}(this, progress, visual=TRUE, ...)
}

\arguments{
 \item{progress}{A \code{\link[base]{double}} in [0,1] specifying the relative progress.}
 \item{visual}{If \code{\link[base:logical]{TRUE}}, the progress bar is redraw, otherwise not.}
 \item{...}{Not used.}
}

\value{
  Returns old value.
}

\author{Henrik Bengtsson}

\seealso{
  \code{\link[R.utils:setValue.ProgressBar]{*setValue}()}.
  \code{\link[R.utils:increase.ProgressBar]{*increase}()}.
  \code{\link[R.utils:reset.ProgressBar]{*reset}()}.
  For more information see \code{\link{ProgressBar}}.
}
\keyword{internal}
\keyword{methods}