Skip to contents

Generic backing the system prompt's board summary. The default method describe_board.board reports the board's blocks, links, stacks and options; describe_board.dock_board adds the view and extension summaries via NextMethod(). Board sub-classes extend the summary by supplying their own method.

Usage

describe_board(b, markers, ...)

# S3 method for class 'board'
describe_board(b, markers, ...)

# S3 method for class 'dock_board'
describe_board(b, markers, ..., view_data = NULL)

Arguments

b

A board.

markers

Named character vector of per-block markers carrying the block's eval status and captured conditions, such as [stale] [1 error], as produced by block_markers().

...

Passed to methods.

view_data

Reactive holding blockr.dock's live all-views layout, or NULL to read views from the committed board. Views are a dock_board concept, so this is consumed only by the dock_board method – where it appears in the signature – not by the base board method.

Value

Character vector of lines, collapsed with paste(..., collapse = "\n") by summarise_board().