Help for package blockr.dag

Title:

A Directed Acyclic Graph Extension for 'blockr'

Version:

0.1.5

Description:

Building on the docking layout manager provided by 'blockr.dock', this provides an extension that allows for visualizing and manipulating a 'blockr' board using a DAG-based user interface powered by the 'g6R' graph visualisation HTML widget.

License:

GPL (≥ 3)

Encoding:

UTF-8

RoxygenNote:

7.3.3

Imports:

blockr.core (≥ 0.1.3), blockr.dock (≥ 0.1.2), shiny, g6R (≥ 0.6.5), jsonlite, htmltools

Suggests:

knitr, rmarkdown, testthat (≥ 3.0.0), roxy.shinylive, webshot2, quarto, cyclocomp, shinytest2, chromote, withr, colorspace

Config/testthat/edition:

URL:

https://bristolmyerssquibb.github.io/blockr.dag/

VignetteBuilder:

quarto

NeedsCompilation:

Packaged:

2026-07-30 14:00:42 UTC; davidgranjon

Author:

David Granjon [aut, cre], Nicolas Bennett [aut], Christoph Sax [aut], Bristol Myers Squibb [fnd]

Maintainer:

David Granjon <david@cynkra.com>

Repository:

CRAN

Date/Publication:

2026-07-30 16:20:21 UTC

Create block ports for g6 node

Description

Create block ports for g6 node

Usage

create_block_ports(block, id)

Arguments

block

Block object.

id

Block ID.

Create network data from board

Description

Create network data from board

Usage

g6_edges_from_links(links, blocks)

g6_nodes_from_blocks(blocks, stacks, children = NULL)

g6_combos_data_from_stacks(stacks)

g6_data_from_board(board)

Arguments

links

Board links.

blocks

Board blocks.

stacks

Board stacks.

children

Named list of children node IDs (optional).

board

Board object.

Get children relationships from links

Description

Get children relationships from links

Usage

get_children_from_links(links)

Arguments

links

Board links

Value

Named list where each element is a list of child node IDs (for JSON array conversion)

Check if a block is variadic

Description

A block is variadic if it has NA arity and no named inputs.

Usage

is_variadic_block(block)

Arguments

block

A block object

Value

Logical indicating if the block is variadic

Context menu functions

Description

Functions for creating and working with context menu entries.

Usage

new_context_menu_entry(
  name,
  js,
  action = NULL,
  condition = TRUE,
  id = tolower(gsub(" +", "_", name))
)

is_context_menu_entry(x)

context_menu_items(x)

Arguments

name

Name of the context menu entry.

js

JavaScript code to execute when the entry is selected.

action

Action to perform when the entry is selected.

condition

Condition to determine if the entry should be shown.

id

Unique identifier for the context menu entry. Inferred from name if not provided

x

Object

Details

new_context_menu_entry(): Creates a new context menu entry with the specified name, JavaScript code, action function, and display condition.
is_context_menu_entry(): Tests whether an object is a valid context menu entry.
context_menu_items(): Generic function to extract context menu items from various objects like dock extensions, boards, or lists.

The context_menu_items.dag_extension() method provides the following actions:

Create link - Creates connections between workflow nodes.
Remove block - Removes individual blocks from the workflow.
Remove link - Removes connections between workflow nodes.
Append block - Adds a new block after the selected node.
Create stack - Creates a new workflow stack.
Remove stack - Removes an entire workflow stack.
Edit stack - Opens stack editing interface.
Add block - Adds a new block to the canvas.

Value

new_context_menu_entry(): A context menu entry object of class "context_menu_entry" containing condition, action, and js functions, with name and id attributes.
is_context_menu_entry(): TRUE if x is a context menu entry, FALSE otherwise.
context_menu_items(): A list of context menu items for the given object.

DAG extension

Description

Visualizes the DAG (directed acyclic graph) underlying a board and provides UI elements to manipulate the board.

Usage

new_dag_extension(positions = NULL, ...)

Arguments

positions

Optional node positions overlaid on the board-derived nodes, as a named list keyed by block id, each element a list with numeric x and y (e.g. list(a = list(x = 100, y = 200))). Persisted across save / restore. Unknown or stale block ids are ignored. This handle is externally controllable: positions can be set programmatically through the board update lifecycle (⁠update(list(extensions = list(mod = list(<ext_id> = list(positions = ...)))))⁠), which moves the corresponding nodes. Note: the auto-layout currently computes final node placement at cold start, so supplied positions are not yet honored over it (a follow-up will let positions pin over the layout).

...

Forwarded to blockr.dock::new_dock_extension().

Value

A dag_extension object that extends the dock extension system for visualizing and manipulating DAG workflows.

Options

blockr.dag.svg_renderer: when TRUE, the DAG is rendered with the SVG renderer instead of the default canvas renderer. Canvas is the default because the SVG element reports offsetWidth == 0, which makes the underlying g-lite client/canvas coordinate scaling ignore the page zoom factor and desyncs hit-testing below 100% browser zoom. The SVG renderer keeps every element in the DOM, which the shinytest2 end-to-end tests need to query and screenshot, so they opt in via AppDriver$new(options = list(blockr.dag.svg_renderer = TRUE)).

Toolbar item functions

Description

Functions for creating and working with toolbar items for the DAG interface.

Usage

new_toolbar_item(id, icon, js, action = NULL, tooltip = NULL)

is_toolbar_item(x)

toolbar_items(x)

Arguments

id

Unique identifier for the toolbar item.

icon

Name of an icon to show in the toolbar.

js

JavaScript code to execute when the entry is selected.

action

Action to perform when the entry is selected.

Optional tooltip text for the entry.

x

Object

Details

new_toolbar_item(): Creates a new toolbar item with the specified id, icon, JavaScript code, action function, and tooltip text.
is_toolbar_item(): Tests whether an object is a valid toolbar item.
toolbar_items(): Generic function to extract toolbar items from various objects like dock extensions, boards, or lists.

The toolbar_items.dag_extension() method provides the following actions:

Zoom in - Increases the graph zoom level.
Zoom out - Decreases the graph zoom level.
Auto fit - Automatically fits the entire graph within the viewport.
Layout - Reapplies the graph layout algorithm to reorganize nodes.
Add block - Opens interface to add a new block to the workflow.
Add stack - Creates a new workflow stack.
Remove selected - Removes currently selected elements from the graph.

Value

new_toolbar_item(): A toolbar item object of class "toolbar_item" containing action and js functions, with id, icon, and tooltip attributes.
is_toolbar_item(): TRUE if x is a toolbar item, FALSE otherwise.
toolbar_items(): A list of toolbar items for the given object.

Resolve target port IDs for links

Description

Resolve target port IDs for links

Usage

resolve_target_ports(links, blocks)

Arguments

links

Board links

blocks

Board blocks

Value

Character vector of target port IDs

Package {blockr.dag}

Create block ports for g6 node

Description

Usage

Arguments

Create network data from board

Description

Usage

Arguments

Get children relationships from links

Description

Usage

Arguments

Value

Check if a block is variadic

Description

Usage

Arguments

Value

Context menu functions

Description

Usage

Arguments

Details

Value

DAG extension

Description

Usage

Arguments

Value

Options

Toolbar item functions

Description

Usage

Arguments

Details

Value

Resolve target port IDs for links

Description

Usage

Arguments

Value