MaestroSchedule {maestro} | R Documentation |
Class for a schedule of pipelines
Description
Class for a schedule of pipelines
Class for a schedule of pipelines
Public fields
PipelineList
object of type MaestroPipelineList
Methods
Public methods
Method new()
Create a MaestroSchedule object
Usage
MaestroSchedule$new(Pipelines = NULL)
Arguments
Pipelines
list of MaestroPipelines
Returns
MaestroSchedule
Method print()
Print the schedule object
Usage
MaestroSchedule$print()
Returns
Method run()
Run a MaestroSchedule
Usage
MaestroSchedule$run(..., quiet = FALSE, run_all = FALSE, n_show_next = 5)
Arguments
...
arguments passed to MaestroPipelineList$run
quiet
whether or not to silence console messages
run_all
run all pipelines regardless of the schedule (default is
FALSE
) - useful for testing.n_show_next
show the next n scheduled pipes
Returns
invisible
Method get_schedule()
Get the schedule as a data.frame
Usage
MaestroSchedule$get_schedule()
Returns
data.frame
Method get_status()
Get status of the pipelines as a data.frame
Usage
MaestroSchedule$get_status()
Returns
data.frame
Method get_artifacts()
Get artifacts (return values) from the pipelines
Usage
MaestroSchedule$get_artifacts()
Returns
list
Method get_network()
Get the network structure of the pipelines as an edge list (will be empty if there are no DAG pipelines)
Usage
MaestroSchedule$get_network()
Returns
data.frame
Method get_flags()
Get all pipeline flags as a long data.frame
Usage
MaestroSchedule$get_flags()
Returns
data.frame
Method show_network()
Visualize the DAG relationships between pipelines in the schedule
Usage
MaestroSchedule$show_network()
Returns
interactive visualization
Method clone()
The objects of this class are cloneable with this method.
Usage
MaestroSchedule$clone(deep = FALSE)
Arguments
deep
Whether to make a deep clone.
Examples
if (interactive()) {
pipeline_dir <- tempdir()
create_pipeline("my_new_pipeline", pipeline_dir, open = FALSE)
schedule <- build_schedule(pipeline_dir = pipeline_dir)
}