cat_custom_diagram: Concatenate a Customized Diagram

In meerapatelmd/suzyBakeOven: Helpers for Package Authoring

Concatenate a Customized Diagram

Description

More custom features passed onto cli::cat_boxx by each node in a diagram.

Usage

cat_custom_diagram(
  flow,
  ...,
  border_style = "single",
  padding = 1,
  margin = 0,
  float = c("left", "center", "right"),
  col = NULL,
  background_col = NULL,
  border_col = col,
  align = c("left", "center", "right"),
  width = cli::console_width()
)

Arguments

flow	String that alternates between a box label and arrows beginning with either - or <.
...	A list named by the string representing a node in the flow string that contains a list of argument-value pair that will be passed to the cli::cat_boxx function.

Details

Example of a named list of customizations passed to the function:

flow <-
  "Test Custom Box -> Test Custom Box 2 -> Test Custom Box 3"

 cat_custom_diagram(
   flow = flow,
   'Test Custom Box 2' =
      list(header = "Database"),
   'Test Custom Box 3' =
      list(border_style = "single-double"))

See Also

console_width,cat_line list2,parse_expr transpose,map capture.output glue

meerapatelmd/suzyBakeOven documentation built on March 30, 2022, 1:44 p.m.