Render Workflow Diagram from File — render_workflow_file • HydraR

Loads a workflow from a file and renders its architecture as a Mermaid diagram. Supports high-fidelity exports to various image formats.

Usage

render_workflow_file(file_path, output_file = NULL, status = FALSE, ...)

Arguments

file_path: String. Path to the YAML workflow file.
output_file: String. Optional path to save the diagram (e.g., "plot.png"). Supported extensions: .png, .pdf, .svg.
status: Logical. If TRUE, styling is applied (requires a valid trace log in the workflow state).
...: Additional arguments passed to `dag$run()`.

Value

A `DiagrammeR` htmlwidget if `output_file` is NULL, otherwise saves the file.

Examples

if (FALSE) { # \dontrun{
# 1. View interactive diagram in RStudio
render_workflow_file("plans/main.yaml")

# 2. Export high-resolution diagram for publication
render_workflow_file(
  file_path = "plans/main.yaml",
  output_file = "reports/figures/workflow_v1.png",
  status = TRUE # Colors nodes by their last status
)
} # }