Graph Decoration

Functions responsible for the decoration of visNetwork graphs, including embedding metadata about drake targets into them.

decorate_plan()

Decorate Plan with a Rich html Description

extract_column_names()

Extract Column Names for targets in Drake Plan

link_col2doc()

Link Column Names to their Documentation.

Javascript Event Handlers

Definitions of event handlers for extending interaction with visNetwork graphs.

alert_event_handler()

Handler for displaying node data as popup

embed_event_handler()

(DEPRECATED) Handler for embedding data into the legend Deprecated lifecycle

Example dataset documentation

Documentation topics produced for the mtcars dataset, designed to support this package’s tutorial material.

lm_object

Linear Models

mtcars_dataset

mtcars Dataset

Roxygen Objects and functions

Functions and objects designed to support the workflow of documenting columns across datasets and packages.

col_roclet() roclet_process(<roclet_col>) roclet_output(<roclet_col>)

Roclet for processing the @col tag

All Functions

All documented functions, that have not otherwise been categorized.

attach_dependencies()

Attach Html Dependencies

extract_named_captures()

Extract named captures from gregexpr

load_colspec_file()

Load colspec from a single file, to be imported into storr cache

load_package_colspec()

Load a package colspec to case

output_paths

Output paths