Description Usage Arguments Value Objects from the Class Slots Extends Methods Author(s) See Also Examples
The SCProgressMonitor
class represents an attempt to abstract
reporting of progress of a task. This class assumes that progress is reported
via a progressbar and provides means to get/set values for such a widget.
1 2 3 4 5 6 7 8 9 10 11 | SCProgressMonitor(stage="")
is.SCProgressMonitor(x)
getStages()
## S4 method for signature 'SCProgressMonitor'
progressMarquee(object)
## S4 replacement method for signature 'SCProgressMonitor,character'
progressMarquee(object) <- value
## S4 method for signature 'SCProgressMonitor'
progressStage(object)
## S4 replacement method for signature 'SCProgressMonitor,character'
progressStage(object) <- value
|
stage |
string specifying current stage of task |
x |
object of (sub)class |
object |
object of (sub)class |
value |
value to be assigned |
The SCProgressMonitor
generator returns an object of class
SCProgressMonitor
.
The getStages
method returns a named character vector specifying
the stages processed by this package.
The is.SCProgressMonitor
method returns TRUE
if its
argument is an object of class SCProgressMonitor
.
Although objects of the class can be created by a direct call to
new, the preferred method is to use the
SCProgressMonitor
generator function.
stage
:string specifying current stage of task
marquee
:string specifying marquee for current task
range
:object of class BoundedRange
label
:string specifying detail label for current task
done
:logical scalar specifying if task completed.
Default is FALSE
.
err
:logical scalar specifying if an error has occurred.
Default is FALSE
.
Class DefaultProgressMonitor
, directly.
Class ProgressMonitor
,
by class “DefaultProgressMonitor”, distance 2.
signature(object = "SCProgressMonitor")
:
Returns string representing current stage of task.
signature(object = "SCProgressMonitor", value = "character")
:
Sets value of the stage
slot.
signature(object = "SCProgressMonitor")
:
Returns string representing marquee for current stage.
signature(object = "SCProgressMonitor", value = "character")
:
Sets value of the marquee
slot.
P. Roebuck proebuck@mdanderson.org
BoundedRange
,
ElapsedTime
,
ProgressMonitor
,
DefaultProgressMonitor
1 2 3 4 5 6 7 8 | showClass("SCProgressMonitor")
niters <- 10
scpm <- SuperCurve:::SCProgressMonitor("input")
progressMarquee(scpm) <- "Read input files"
for (i in seq.int(niters)) {
## Perform portion of task
progressValue(scpm) <- i # Modify current value
}
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.