Decorate Plan with a Rich html Description

Source: R/decorate_graph.R

Decorate Plan with a Rich html Description

decorate_plan(
  plan,
  cache,
  group = NULL,
  clusters = NULL,
  desc_colname = "desc",
  colname_out = desc_colname,
  lookup_cache = NULL,
  json_render = TRUE,
  ...
)

Arguments

group

Optional character scalar, name of the column used to group nodes into columns. All the columns names of your original drake plan are choices. The other choices (such as "status") are column names in the nodes . To group nodes into clusters in the graph, you must also supply the clusters argument.
clusters

Optional character vector of values to cluster on. These values must be elements of the column of the nodes data frame that you specify in the group argument to drake_graph_info().
desc_colname

the name of the column that provides the markdown description
colname_out

the name of the column in which to store the enriched description
lookup_cache

the storr::storr object, generated by load_package_colspec(), containing keys (given by column aliases) mapping to column metadata lists.
json_render

Deprecated lifecycle logical. if TRUE, render the output as json, otherwise, render it as html setting this to FALSE is not recommended, this parameter was added for backward compatibility.

See also

Other graph_decoration: extract_column_names(), link_col2doc()