get_metrics: Get metrics recorded by pipelines in a MaestroSchedule object

View source: R/metrics.R

get_metricsR Documentation

Get metrics recorded by pipelines in a MaestroSchedule object

Description

Creates a long data.frame of metrics recorded via update_metric() for all pipelines in the schedule, across all runs.

Usage

get_metrics(schedule)

Arguments

schedule

object of type MaestroSchedule created using build_schedule()

Value

data.frame with columns pipe_name, run_id, metric, value (numeric)

Examples

if (interactive()) {
  pipeline_dir <- tempdir()
  create_pipeline("my_new_pipeline", pipeline_dir, open = FALSE)
  schedule <- build_schedule(pipeline_dir = pipeline_dir)

  schedule <- run_schedule(
    schedule,
    orch_frequency = "1 day",
    quiet = TRUE
  )

  get_metrics(schedule)

  # Alternatively, use the underlying R6 method
  schedule$get_metrics()
}

maestro documentation built on Oct. 14, 2026, 5:07 p.m.