GraphRunner R6 class

The compiled, executable graph. Produced by StateGraph$compile(). Do not call GraphRunner$new() directly; use StateGraph$compile().

Value

The final WorkflowState object.

A coro generator yielding list(node, state_snapshot, iteration).

State snapshot (named list) or NULL.

A data frame with columns agent, provider, model, input_tokens, output_tokens, cost.

Character string.

Character string.

Invisibly, path.

Methods

Public methods

• GraphRunner$new()

• GraphRunner$invoke()

• GraphRunner$stream()

• GraphRunner$get_state()

• GraphRunner$update_state()

• GraphRunner$cost_report()

• GraphRunner$as_dot()

• GraphRunner$as_mermaid()

• GraphRunner$visualize()

• GraphRunner$export_diagram()

• GraphRunner$print()

• GraphRunner$clone()

---

Method new()

Initialise the runner. Called internally by StateGraph$compile().

Usage

GraphRunner$new(
  nodes,
  edges,
  conditional_edges,
  state_schema,
  agents,
  checkpointer,
  termination,
  output_channel = NULL
)

Arguments

nodes

Named list of list(fn = <function>).

edges

List of list(from, to).

conditional_edges

List of list(from, routing_fn, route_map).

state_schema

A WorkflowState object (used as schema template).

agents

Named list of Agent objects.

checkpointer

A Checkpointer or NULL.

termination

A termination_condition or NULL.

output_channel

Character or NULL. Name of the channel returned by WorkflowState$output() after $invoke().

---

Method invoke()

Execute the graph and return the final state.

Usage

GraphRunner$invoke(initial_state = list(), config = list())

Arguments

initial_state

Named list of initial channel overrides.

config

Named list of run-time configuration:

• thread_id: character, identifies this run for checkpointing.

• max_iterations: integer, cycle guard (default 25).

• on_step: function(node_name, state) callback after each node.

• verbose: logical, print step info via cli (default FALSE).

---

Method stream()

Stream graph execution, yielding after each node.

Usage

GraphRunner$stream(initial_state = list(), config = list())

Arguments

initial_state

Named list of initial channel overrides.

config

Named list (same keys as $invoke()).

---

Method get_state()

Retrieve the last checkpointed state for a thread.

Usage

GraphRunner$get_state(thread_id)

Arguments

thread_id

Character.

---

Method update_state()

Manually update a checkpointed state (human-in-the-loop).

Usage

GraphRunner$update_state(thread_id, updates)

Arguments

thread_id

Character.

updates

Named list of channel updates.

---

Method cost_report()

Return a cost report across all agents.

Usage

GraphRunner$cost_report()

---

Method as_dot()

Generate a DOT language string for the graph.

Usage

GraphRunner$as_dot()

---

Method as_mermaid()

Generate a Mermaid diagram string.

Usage

GraphRunner$as_mermaid()

---

Method visualize()

Render a visualization of the compiled graph.

Usage

GraphRunner$visualize(engine = c("dot", "visnetwork", "mermaid"))

Arguments

engine

One of "dot", "visnetwork", or "mermaid".

---

Method export_diagram()

Export the diagram to a file.

Usage

GraphRunner$export_diagram(path, width = 800L, height = 600L)

Arguments

path

File path. Extension determines format (.svg or .png).

width

Integer. Width in pixels (PNG only).

height

Integer. Height in pixels (PNG only).

---

Method print()

Print runner summary.

Usage

GraphRunner$print(...)

Arguments

...

Ignored.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

GraphRunner$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.