PipelineResult {ravepipeline} | R Documentation |
Pipeline result object
Description
Pipeline result object
Pipeline result object
Value
TRUE
if the target is finished, or FALSE
if
timeout is reached
Public fields
progressor
progress bar object, usually generated a progress instance
promise
a
promise
instance that monitors the pipeline progressverbose
whether to print warning messages
names
names of the pipeline to build
async_callback
function callback to call in each check loop; only used when the pipeline is running in
async=TRUE
modecheck_interval
used when
async=TRUE
inpipeline_run
, interval in seconds to check the progress
Active bindings
variables
target variables of the pipeline
variable_descriptions
readable descriptions of the target variables
valid
logical true or false whether the result instance hasn't been invalidated
status
result status, possible status are
'initialize'
,'running'
,'finished'
,'canceled'
, and'errored'
. Note that'finished'
only means the pipeline process has been finished.process
(read-only) process object if the pipeline is running in
'async'
mode, orNULL
; seer_bg
.
Methods
Public methods
Method validate()
check if result is valid, raises errors when invalidated
Usage
PipelineResult$validate()
Method invalidate()
invalidate the pipeline result
Usage
PipelineResult$invalidate()
Method get_progress()
get pipeline progress
Usage
PipelineResult$get_progress()
Method new()
constructor (internal)
Usage
PipelineResult$new(path = character(0L), verbose = FALSE)
Arguments
path
pipeline path
verbose
whether to print warnings
Method run()
run pipeline (internal)
Usage
PipelineResult$run( expr, env = parent.frame(), quoted = FALSE, async = FALSE, process = NULL )
Arguments
expr
expression to evaluate
env
environment of
expr
quoted
whether
expr
has been quotedasync
whether the process runs in other sessions
process
the process object inherits
process
, will be inferred fromexpr
ifprocess=NULL
, and will raise errors if cannot be found
Method await()
wait until some targets get finished
Usage
PipelineResult$await(names = NULL, timeout = Inf)
Arguments
names
target names to wait, default is
NULL
, i.e. to wait for all targets that have been scheduledtimeout
maximum waiting time in seconds
Method print()
print method
Usage
PipelineResult$print()
Method get_values()
get results
Usage
PipelineResult$get_values(names = NULL, ...)
Arguments
names
the target names to read
...
passed to
pipeline_read
Method clone()
The objects of this class are cloneable with this method.
Usage
PipelineResult$clone(deep = FALSE)
Arguments
deep
Whether to make a deep clone.